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:

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

public class LayoutDisplayPropertyGroup

extends DefaultPropertyGroup

implements INavigationObject, ITemplate

See Also:

Serialized Form

Field Summary

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

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

Fields inherited from interface planetj.dataengine.display.ITemplate

JSP_BODY, JSP_BOTTOM_NAVIGATION, JSP_ERROR, JSP_FOOTER, JSP_HEADER, JSP_LEFT_NAVIGATION, JSP_MESSAGE, JSP_NAVIGATION_BAR, JSP_RIGHT_NAVIGATION, JSP_TEMPLATE, JSP_TOC, JSP_TOP_NAVIGATION

Constructor Summary

LayoutDisplayPropertyGroup()
DisplayPropertyGroup constructor comment.

LayoutDisplayPropertyGroup(int initialCapacity)
DisplayPropertyGroup constructor comment.

LayoutDisplayPropertyGroup(java.lang.String pName)
DisplayPropertyGroup constructor comment.

Method Summary

LayoutDisplayPropertyGroup	cloneLayout()
java.lang.String	getBody() Convenience method to get the body of the template.
java.lang.String	getBottomNavigation() Convenience method to get the bottom navigation of the template.
java.lang.String	getCSS() Convenience method to get the css of the template.
static java.lang.String	getDefaultLayoutPropertiesString() Gets a default String for this property group.
java.lang.String	getDefaultPropertiesString() Gets a default String for this property group.
java.lang.String	getError() Convenience method to get the error page of the template.
java.lang.String	getFooter() Convenience method to get the header of the template.
java.lang.String	getHeader() Convenience method to get the header of the template.
java.lang.String	getHeadingText() Convenience method to get the heading text of the application.
java.lang.String	getLeftNavigation() Convenience method to get the left navigation of the template.
java.lang.String	getMessage() Convenience method to get the message of the template.
java.lang.String	getNavigationBar() Convenience method to get the navigation bar of the template.
java.lang.String	getNavigationKey() Get the key used to store and retrieve this object to and from navigation.
java.lang.String	getNavigationListKey() Get the key used to store and retrieve this object to and from navigation.
PageType	getPageType(java.lang.String section) Gets the type of page being displayed in the particular template section
static java.lang.String	getPageTypeKey(java.lang.String section) Gets the key used to store the page type of the specified section
java.lang.String	getRightNavigation() Convenience method to get the right navigation of the template.
java.lang.String	getSection(java.lang.String key) Get the key used to store and retrieve this object to and from navigation.
java.lang.String	getSubHeadingText() Convenience method to get the sub heading text of the application.
java.lang.String	getTemplate() Gets the template for this layout property group.
java.lang.String	getTitle() Convenience method to get the title for the page being loaded.
java.lang.String	getToc() Deprecated. replaced with getTOC()... TOC is an abbreviation for table of contents... upper cased to make more sense
java.lang.String	getTOC() Convenience method to get the toc (side navigation bar) of the template.
java.lang.String	getTopNavigation() Convenience method to get the top navigation 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(java.lang.String key) Set the key used to store/retrieve this layout property group to/from navigation.
void	setPageType(java.lang.String templateSection, PageType pageType) Sets the type of page being displayed in the particular template section
void	setSection(java.lang.String templateSection, java.lang.String page) Set the page for the given section for the layout
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, propertyType

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

clone

Methods inherited from interface java.util.Map

equals, hashCode

Field Detail

className

public static final java.lang.String className

Class name

LAYOUT_DISPLAY

public static final java.lang.String LAYOUT_DISPLAY

See Also:

Constant Field Values

TOC_WIDTH

public static final java.lang.String TOC_WIDTH

See Also:

Constant Field Values

DEFAULT_TEMPLATE

public static final java.lang.String DEFAULT_TEMPLATE

Value used to denote the default template for layout properties.

See Also:

Constant Field Values

STYLE_SHEET

public static final java.lang.String STYLE_SHEET

See Also:

Constant Field Values

TEXT_COMPANY

public static final java.lang.String TEXT_COMPANY

See Also:

Constant Field Values

TEXT_HEADING

public static final java.lang.String TEXT_HEADING

See Also:

Constant Field Values

TEXT_SUB_HEADING

public static final java.lang.String TEXT_SUB_HEADING

See Also:

Constant Field Values

HELP_URI

public static final java.lang.String HELP_URI

See Also:

Constant Field Values

TITLE

public static final java.lang.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(java.lang.String pName)

DisplayPropertyGroup constructor comment.

Parameters:

pName - java.lang.String

Method Detail

getPageTypeKey

public static java.lang.String getPageTypeKey(java.lang.String section)

Gets the key used to store the page type of the specified section

cloneLayout

public LayoutDisplayPropertyGroup cloneLayout()

getBody

public java.lang.String getBody()

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

getBottomNavigation

public java.lang.String getBottomNavigation()

Convenience method to get the bottom navigation of the template.

getCSS

public java.lang.String getCSS()

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

getDefaultLayoutPropertiesString

public static java.lang.String getDefaultLayoutPropertiesString()

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

getDefaultPropertiesString

public java.lang.String getDefaultPropertiesString()

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

Overrides:

getDefaultPropertiesString in class DefaultPropertyGroup

getFooter

public java.lang.String getFooter()

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

getError

public java.lang.String getError()

Convenience method to get the error page of the template.

getHeader

public java.lang.String getHeader()

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

getHeadingText

public java.lang.String getHeadingText()

Convenience method to get the heading text of the application. There may or may not be heading text.

getLeftNavigation

public java.lang.String getLeftNavigation()

Convenience method to get the left navigation of the template. (Similar to TOC in old templates)

getMessage

public java.lang.String getMessage()

Convenience method to get the message of the template. There may or may not be a message section.

getNavigationBar

public java.lang.String getNavigationBar()

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

getNavigationKey

public java.lang.String getNavigationKey()

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

Specified by:

getNavigationKey in interface INavigationObject

getNavigationListKey

public java.lang.String getNavigationListKey()

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

Specified by:

getNavigationListKey in interface INavigationObject

getPageType

public PageType getPageType(java.lang.String section)

Gets the type of page being displayed in the particular template section

getRightNavigation

public java.lang.String getRightNavigation()

Convenience method to get the right navigation of the template.

getSection

public java.lang.String getSection(java.lang.String key)

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

getSubHeadingText

public java.lang.String getSubHeadingText()

Convenience method to get the sub heading text of the application. There may or may not be sub eading text.

getTemplate

public java.lang.String getTemplate()

Gets the template for this layout property group.

getTitle

public java.lang.String getTitle()

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

getToc

public java.lang.String getToc()

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

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

getTOC

public java.lang.String getTOC()

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

getTopNavigation

public java.lang.String getTopNavigation()

Convenience method to get the top navigation of the template. (Similar to 'navbar' in old templates)

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

setPageType

public void setPageType(java.lang.String templateSection,
                        PageType pageType)

Sets the type of page being displayed in the particular template section

setSection

public void setSection(java.lang.String templateSection,
                       java.lang.String page)

Set the page for the given section for the layout

setNavigationKey

public void setNavigationKey(java.lang.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