planetj.dataengine.display
Class FramePropertyGroup

java.lang.Object
  java.util.AbstractMap
      java.util.HashMap
          planetj.property.PropertyGroup
              planetj.dataengine.display.FramePropertyGroup

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, java.util.Map, java.io.Serializable

public class FramePropertyGroup

extends PropertyGroup

Properties dealing with an HTML frame

See Also:

Serialized Form

Field Summary

static java.util.List	ALL_PROPS
static java.lang.String	FRAME
static java.lang.String	HEIGHT Height (either pixels or %)
static java.lang.String	ID The HTML id of the frame
static java.lang.String	URL The initial URL of the frame
static java.lang.String	WIDTH Width (either pixels or %)
static java.lang.String	X X position (0-based)
static java.lang.String	Y Y position (0-based)

Fields inherited from class planetj.property.PropertyGroup

ALL, ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, FLOAT_PROPERTY, INTEGER_PROPERTY, JAVA_CLASS_PROPERTY, LIST_PROPERTY, MAP_PROPERTY, NONE, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

FramePropertyGroup()
FramePropertyGroup constructor comment.

FramePropertyGroup(java.lang.String pName)
FramePropertyGroup constructor comment.

Method Summary

static java.util.List	createDefaultFrames(java.lang.Class jspClass) Builds a list of FrameProperty Group objects containing default values for x, y, height, width, and id based on the name of the JSP class.
static java.util.List	createDefaultFrames(int rowCount, int colCount) Builds a list of FrameProperty Group objects containing default values for x, y, height, width, and id
java.util.List	getAllPropertyNames() Gets a List containing the names of all the supported properties, not including metaproperties.
java.lang.String	getHeight() Gets the height of the frame (may be pixels or %)
java.lang.String	getId() Gets the html id of the frame
java.lang.String	getInitialURL() Gets the initial URL of the frame
java.util.List	getRequiredPropertyNames() Gets a List containing the names of all the required properties.
java.lang.String	getWidth() Gets the width of the frame (may be pixels or %)
int	getX() Gets the 0-based x index of the frame
int	getY() Gets the 0-based y index of the frame
protected short	propertyType(java.lang.String pPropertyName) Gets the type of property for a specified property name.

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, copyUndefinedPropertiesFrom, createProperty, createValue, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateFormat, getDateValue, getDoubleValue, getFloatValue, getIntValue, getJavaClassValue, getListValue, getMapValue, getName, getProperty, getPropertyType, getStringValue, getValue, isMergeableOnList, isMetaproperty, iterator, mergeOnList, metapropertyType, put, put, put, setName, toString, updateProperty, validate, validateMetadata, validateMetadataBoolean

Methods inherited from class java.util.HashMap

clear, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

FRAME

public static final java.lang.String FRAME

See Also:

Constant Field Values

X

public static final java.lang.String X

X position (0-based)

See Also:

Constant Field Values

Y

public static final java.lang.String Y

Y position (0-based)

See Also:

Constant Field Values

WIDTH

public static final java.lang.String WIDTH

Width (either pixels or %)

See Also:

Constant Field Values

HEIGHT

public static final java.lang.String HEIGHT

Height (either pixels or %)

See Also:

Constant Field Values

ID

public static final java.lang.String ID

The HTML id of the frame

See Also:

Constant Field Values

URL

public static final java.lang.String URL

The initial URL of the frame

See Also:

Constant Field Values

ALL_PROPS

public static final java.util.List ALL_PROPS

Constructor Detail

FramePropertyGroup

public FramePropertyGroup()

FramePropertyGroup constructor comment.

FramePropertyGroup

public FramePropertyGroup(java.lang.String pName)

FramePropertyGroup constructor comment.

Parameters:

pName - java.lang.String

Method Detail

createDefaultFrames

public static java.util.List createDefaultFrames(int rowCount,
                                                 int colCount)

Builds a list of FrameProperty Group objects containing default values for x, y, height, width, and id

createDefaultFrames

public static java.util.List createDefaultFrames(java.lang.Class jspClass)
                                          throws CMException

Builds a list of FrameProperty Group objects containing default values for x, y, height, width, and id based on the name of the JSP class. The names should contain the String "[rows-count]x[column-count]template" where [row-count] is the number of rows and [column-count] is the number of columns in the frameset

Throws:

CMException

getAllPropertyNames

public java.util.List getAllPropertyNames()

Gets a List containing the names of all the supported properties, not including metaproperties.

Specified by:

getAllPropertyNames in class PropertyGroup

getHeight

public java.lang.String getHeight()

Gets the height of the frame (may be pixels or %)

getId

public java.lang.String getId()

Gets the html id of the frame

getInitialURL

public java.lang.String getInitialURL()

Gets the initial URL of the frame

getRequiredPropertyNames

public java.util.List getRequiredPropertyNames()

Gets a List containing the names of all the required properties.

Specified by:

getRequiredPropertyNames in class PropertyGroup

getWidth

public java.lang.String getWidth()

Gets the width of the frame (may be pixels or %)

getX

public int getX()

Gets the 0-based x index of the frame

getY

public int getY()

Gets the 0-based y index of the frame

propertyType

protected short propertyType(java.lang.String pPropertyName)

Gets the type of property for a specified property name.

Specified by:

propertyType in class PropertyGroup