planetj.dataengine.display
Class FramePropertyGroup

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

All Implemented Interfaces:

Cloneable, Comparable, Map, Serializable

public class FramePropertyGroup

extends PropertyGroup

Properties dealing with an HTML frame

See Also:

Serialized Form

Field Summary

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

Fields inherited from class planetj.property.PropertyGroup

ALL_FALSE, ALL_TRUE, BOOLEAN_PROPERTY, DATE_PROPERTY, DOUBLE_PROPERTY, INTEGER_PROPERTY, LIST_PROPERTY, ROW_COLLECTION_KEY, STRING_PROPERTY

Constructor Summary

FramePropertyGroup()
FramePropertyGroup constructor comment.

FramePropertyGroup(String pName)
FramePropertyGroup constructor comment.

Method Summary

static List	createDefaultFrames(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 List	createDefaultFrames(int rowCount, int colCount) Builds a list of FrameProperty Group objects containing default values for x, y, height, width, and id
List	getAllPropertyNames() Gets a List containing the names of all the supported properties, not including metaproperties.
String	getHeight() Gets the height of the frame (may be pixels or %)
String	getId() Gets the html id of the frame
String	getInitialURL() Gets the initial URL of the frame
List	getRequiredPropertyNames() Gets a List containing the names of all the required properties.
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

Methods inherited from class planetj.property.PropertyGroup

add, addProperty, addProperty, append, clone, compareTo, compareTo, compareTo, containsProperty, createProperty, getAllMetapropertyNames, getAllSetBooleanPropertyNames, getAllSetIntPropertyNames, getAllSetListPropertyNames, getAllSetPropertyNames, getAllSetStringPropertyNames, getBooleanValue, getDateValue, getDoubleValue, getIntValue, getListValue, getName, getProperty, getPropertyType, getStringValue, getValue, isMergeableOnList, isMetaproperty, iterator, mergeOnList, put, put, put, setName, toString, updateProperty

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

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

FRAME

public static final String FRAME

See Also:

Constant Field Values

X

public static final String X

X position (0-based)

See Also:

Constant Field Values

Y

public static final String Y

Y position (0-based)

See Also:

Constant Field Values

WIDTH

public static final String WIDTH

Width (either pixels or %)

See Also:

Constant Field Values

HEIGHT

public static final String HEIGHT

Height (either pixels or %)

See Also:

Constant Field Values

ID

public static final String ID

The HTML id of the frame

See Also:

Constant Field Values

URL

public static final String URL

The initial URL of the frame

See Also:

Constant Field Values

ALL_PROPS

public static final List ALL_PROPS

Constructor Detail

FramePropertyGroup

public FramePropertyGroup()

FramePropertyGroup constructor comment.

FramePropertyGroup

public FramePropertyGroup(String pName)

FramePropertyGroup constructor comment.

Parameters:

pName - java.lang.String

Method Detail

createDefaultFrames

public static 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 List createDefaultFrames(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

CMException

getAllPropertyNames

public List getAllPropertyNames()

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

Specified by:

getAllPropertyNames in class PropertyGroup

getHeight

public String getHeight()

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

getId

public String getId()

Gets the html id of the frame

getInitialURL

public String getInitialURL()

Gets the initial URL of the frame

getRequiredPropertyNames

public List getRequiredPropertyNames()

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

Specified by:

getRequiredPropertyNames in class PropertyGroup

getWidth

public 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