planetj.dataengine.display
Class LayoutDisplayPropertyGroup

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

All Implemented Interfaces:

Cloneable, Comparable, INavigationObject, ITemplate, Map, Serializable

public class LayoutDisplayPropertyGroup

extends DefaultPropertyGroup

implements INavigationObject, ITemplate

See Also:

Serialized Form

Field Summary

static String	className Class name
static String	DEFAULT_TEMPLATE Value used to denote the default template for layout properties.
static String	HELP_URI
static String	LAYOUT_DISPLAY
static LayoutDisplayPropertyGroup	SKINNY A predifined layout display with no TOC, header, or footer
static String	STYLE_SHEET
static String	TEXT_COMPANY
static String	TEXT_HEADING
static String	TEXT_SUB_HEADING
static String	TITLE Title for the page being loaded
static String	TOC_WIDTH

Fields inherited from class planetj.property.DefaultPropertyGroup

NONE

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

Fields inherited from interface planetj.dataengine.display.ITemplate

JSP_BODY, JSP_ERROR, JSP_FOOTER, JSP_HEADER, JSP_NAVIGATION_BAR, JSP_TEMPLATE, JSP_TOC

Constructor Summary

LayoutDisplayPropertyGroup()
DisplayPropertyGroup constructor comment.

LayoutDisplayPropertyGroup(int initialCapacity)
DisplayPropertyGroup constructor comment.

LayoutDisplayPropertyGroup(String pName)
DisplayPropertyGroup constructor comment.

Method Summary

LayoutDisplayPropertyGroup	cloneLayout()
String	getBody() Convience method to get the body of the template.
String	getCSS() Convience method to get the css of the template.
static String	getDefaultLayoutPropertiesString() Gets a default String for this property group.
String	getDefaultPropertiesString() Gets a default String for this property group.
String	getError() Convience method to get the error page of the template.
String	getFooter() Convience method to get the header of the template.
String	getHeader() Convience method to get the header of the template.
String	getNavigationBar() Convience method to get the navigation bar of the template.
String	getNavigationKey() Get the key used to store and retrieve this object to and from navigation.
String	getNavigationListKey() Get the key used to store and retrieve this object to and from navigation.
String	getSection(String key) Get the key used to store and retrieve this object to and from navigation.
String	getTemplate() Gets the template for this layout property group.
String	getTitle() Convience method to get the title for the page being loaded.
String	getToc() Deprecated. replaced with getTOC()... TOC is an abbreviation for table of contents... upper cased to make more sense
String	getTOC() Convience method to get the toc (side navigation bar) of the template.
boolean	isCloneNeeded() Test to see if tiis navigation object should be clone upon storing and retrieving.
void	removeNavigationKey() Clears out any navigation key that may have been set on this Row.
void	setNavigationKey(String key) Set the key used to store/retrieve this layout property group to/from navigation.
static LayoutDisplayPropertyGroup	updateProperties(LayoutDisplayPropertyGroup current, LayoutDisplayPropertyGroup newProps) Updates all properties in the "current" layout from those in the "new" layout

Methods inherited from class planetj.property.DefaultPropertyGroup

getAllPropertyNames, getRequiredPropertyNames

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 planetj.dataengine.INavigationObject

clone

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

className

public static final String className

Class name

LAYOUT_DISPLAY

public static final String LAYOUT_DISPLAY

See Also:

Constant Field Values

TOC_WIDTH

public static final String TOC_WIDTH

See Also:

Constant Field Values

DEFAULT_TEMPLATE

public static final String DEFAULT_TEMPLATE

Value used to denote the default template for layout properties.

See Also:

Constant Field Values

STYLE_SHEET

public static final String STYLE_SHEET

See Also:

Constant Field Values

TEXT_COMPANY

public static final String TEXT_COMPANY

See Also:

Constant Field Values

TEXT_HEADING

public static final String TEXT_HEADING

See Also:

Constant Field Values

TEXT_SUB_HEADING

public static final String TEXT_SUB_HEADING

See Also:

Constant Field Values

HELP_URI

public static final String HELP_URI

See Also:

Constant Field Values

TITLE

public static final String TITLE

Title for the page being loaded

See Also:

Constant Field Values

SKINNY

public static final LayoutDisplayPropertyGroup SKINNY

A predifined layout display with no TOC, header, or footer

Constructor Detail

LayoutDisplayPropertyGroup

public LayoutDisplayPropertyGroup()

DisplayPropertyGroup constructor comment.

LayoutDisplayPropertyGroup

public LayoutDisplayPropertyGroup(int initialCapacity)

DisplayPropertyGroup constructor comment.

Parameters:

initialCapacity - int

LayoutDisplayPropertyGroup

public LayoutDisplayPropertyGroup(String pName)

DisplayPropertyGroup constructor comment.

Parameters:

pName - java.lang.String

Method Detail

cloneLayout

public LayoutDisplayPropertyGroup cloneLayout()

getBody

public String getBody()

Convience method to get the body of the template. There may or may not be a body section.

getCSS

public String getCSS()

Convience method to get the css of the template. There may or may not be a css section.

getDefaultLayoutPropertiesString

public static String getDefaultLayoutPropertiesString()

Gets a default String for this property group. All properties are listed without any values.

getDefaultPropertiesString

public String getDefaultPropertiesString()

Gets a default String for this property group. All properties are listed without any values.

Overrides:

getDefaultPropertiesString in class DefaultPropertyGroup

getFooter

public String getFooter()

Convience method to get the header of the template. There may or may not be a footer section.

getError

public String getError()

Convience method to get the error page of the template.

getHeader

public String getHeader()

Convience method to get the header of the template. There may or may not be a header section.

getNavigationBar

public String getNavigationBar()

Convience method to get the navigation bar of the template. There may or may not be a navigation bar section.

getNavigationKey

public String getNavigationKey()

Get the key used to store and retrieve this object to and from navigation.

Specified by:

getNavigationKey in interface INavigationObject

getNavigationListKey

public String getNavigationListKey()

Get the key used to store and retrieve this object to and from navigation.

Specified by:

getNavigationListKey in interface INavigationObject

getSection

public String getSection(String key)

Get the key used to store and retrieve this object to and from navigation.

getTemplate

public String getTemplate()

Gets the template for this layout property group.

getTitle

public String getTitle()

Convience method to get the title for the page being loaded.

getToc

public String getToc()

Deprecated. replaced with getTOC()... TOC is an abbreviation for table of contents... upper cased to make more sense

Convience method to get the toc (side navigation bar) of the template. There may or may not be a toc section.

getTOC

public String getTOC()

Convience method to get the toc (side navigation bar) of the template. There may or may not be a toc section.

isCloneNeeded

public boolean isCloneNeeded()

Description copied from interface: INavigationObject

Test to see if tiis navigation object should be clone upon storing and retrieving.

Specified by:

isCloneNeeded in interface INavigationObject

removeNavigationKey

public void removeNavigationKey()

Clears out any navigation key that may have been set on this Row.

Specified by:

removeNavigationKey in interface INavigationObject

setNavigationKey

public void setNavigationKey(String key)

Set the key used to store/retrieve this layout property group to/from navigation.

Specified by:

setNavigationKey in interface INavigationObject

updateProperties

public static LayoutDisplayPropertyGroup updateProperties(LayoutDisplayPropertyGroup current,
                                                          LayoutDisplayPropertyGroup newProps)

Updates all properties in the "current" layout from those in the "new" layout