com.sage.swt.client.ui.builder
Class DefaultUIDefinition

java.lang.Object
  com.sage.swt.client.ui.builder.DefaultUIDefinition

All Implemented Interfaces:

UIDefinition

public class DefaultUIDefinition
extends java.lang.Object
implements UIDefinition

The default implementation of the UIDefinition interface. This contains information common to all instances of the declarative UI definition.

Constructor Summary

DefaultUIDefinition()
Constructs an empty UI definition context.

Method Summary

java.lang.String	getApplicationMenuXML() Gets the XML of the applicationMenus section in the declarative UI definition used as a basis for creating this instance context.
ConnectionsDefinition	getConnectionsDefinition() Gets the connections definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.
DataSourcesDefinition	getDataSourcesDefinition() Gets the datasources definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.
java.util.List<com.google.gwt.xml.client.Element>	getHandlerElements() Gets the handler elements for the UI definition context, as found in the associated declarative UI definition.
java.lang.String	getHelpID() Gets the help ID of this UI definition context, as found in the associated declarative UI definition.
java.lang.String	getID() Gets the ID of this UI definition context, as found in the associated declarative UI definition.
java.util.List<java.lang.String>	getKeyDatasourceIDs() Gets the non-null list of data source IDs used for navigation on this UI, as found in the associated declarative UI definition.
java.lang.String	getKeyLookupDatasourceID() Gets the non-null data source ID which acts as a separate instance from the main data source to handle the key change on this UI such as OE Order Entry, as found in the associated declarative UI definition.
java.util.List<java.lang.String>	getKeyWidgetIDs() Gets the non-null list of key widget IDs on this UI, as found in the associated declarative UI definition.
java.util.Map<java.lang.String,java.lang.String>	getMessages() Gets the map of messages for the UI definition context, as found in the associated declarative UI definition.
java.util.List<com.google.gwt.xml.client.Element>	getPopupElements() Gets the popup form elements for the UI definition context, as found in the associated declarative UI definition.
ConnectionsDefinition	getPrefConnectionsDefinition() Gets the preference store connections definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.
DataSourcesDefinition	getPreferenceStoresDefinition() Gets the preferenceStore definition for the UI context, as found in the associated declarative UI definition
com.google.gwt.xml.client.Element	getRootWidgetElement() Gets the root widget for the UI definition context, as found in the associated declarative UI definition.
java.util.List<java.lang.String>	getScriptContents() Gets the list of script contents for the UI definition context, as found in the associated declarative UI definition and in external scripts specified in that declarative UI definition.
java.util.Map<java.lang.String,java.lang.String>	getShortToLongNamespaces() Gets the map of short to long namespaces for the UI definition context, as found in the associated declarative UI definition.
java.util.List<java.lang.String>	getStyleContents() Gets the list of style contents for the UI definition context, as found in the associated declarative UI definition and in external styles specified in that declarative UI definition.
java.util.List<com.google.gwt.xml.client.Element>	getTopicElements() Gets the topic elements for the UI definition context, as found in the associated declarative UI definition.
void	setApplicationMenuXML(java.lang.String menuXML) Sets the XML for the applicationMenus section of the Ui Definition.
void	setConnectionsDefinition(ConnectionsDefinition connectionsDefinition) Sets the connections definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.
void	setDataSourcesDefinition(DataSourcesDefinition dataSourcesDefinition) Sets the datasources definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.
void	setHandlerElements(java.util.List<com.google.gwt.xml.client.Element> handlerElements) Sets the handler form elements for the UI definition context, as found in the associated declarative UI definition.
void	setHelpID(java.lang.String helpID) Sets the help ID of this UI definition context, as found in the associated declarative UI definition.
void	setID(java.lang.String id) Sets the ID of this UI definition context, as found in the associated declarative UI definition.
void	setMessages(java.util.Map<java.lang.String,java.lang.String> messages) Sets the map of messages for the UI definition context, as found in the associated declarative UI definition.
void	setPopupElements(java.util.List<com.google.gwt.xml.client.Element> popupElements) Sets the popup form elements for the UI definition context, as found in the associated declarative UI definition.
void	setPreferenceConnectionsDefinition(ConnectionsDefinition connectionsDefinition) Sets the preference store connections definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.
void	setPreferenceStoresDefinition(DataSourcesDefinition preferenceStoresDefinition) Sets the PreferenceStores datasources definitions for the UI context, as found in the associated declarative UI definition
void	setRootWidgetElement(com.google.gwt.xml.client.Element rootWidgetElement) Sets the root widget for the UI definition context, as found in the associated declarative UI definition.
void	setScriptContents(java.util.List<java.lang.String> scriptContents) Sets the list of script contents for the UI definition context, as found in the associated declarative UI definition and in external scripts specified in that declarative UI definition.
void	setShortToLongNamespaces(java.util.Map<java.lang.String,java.lang.String> shortToLongNamespaces) Sets the map of short to long namespaces for the UI definition context, as found in the associated declarative UI definition.
void	setStyleContents(java.util.List<java.lang.String> styleContents) Sets the list of style contents for the UI definition context, as found in the associated declarative UI definition and in external styles specified in that declarative UI definition.
void	setTopicElements(java.util.List<com.google.gwt.xml.client.Element> topicElements) Sets the topic elements for the UI definition context, as found in the associated declarative UI definition.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultUIDefinition

public DefaultUIDefinition()

Constructs an empty UI definition context.

Method Detail

getID

public java.lang.String getID()

Gets the ID of this UI definition context, as found in the associated declarative UI definition.

Specified by:

getID in interface UIDefinition

Returns:

The ID of this UI definition context, as found in the associated declarative UI definition.

setID

public void setID(java.lang.String id)

Sets the ID of this UI definition context, as found in the associated declarative UI definition.

Parameters:

id - The ID of this UI definition context, as found in the associated declarative UI definition.

getHelpID

public java.lang.String getHelpID()

Gets the help ID of this UI definition context, as found in the associated declarative UI definition.

Specified by:

getHelpID in interface UIDefinition

Returns:

The help ID of this UI definition context, as found in the associated declarative UI definition.

setHelpID

public void setHelpID(java.lang.String helpID)

Sets the help ID of this UI definition context, as found in the associated declarative UI definition.

Parameters:

helpID - The help ID of this UI definition context, as found in the associated declarative UI definition.

getKeyDatasourceIDs

public java.util.List<java.lang.String> getKeyDatasourceIDs()

Gets the non-null list of data source IDs used for navigation on this UI, as found in the associated declarative UI definition.

Specified by:

getKeyDatasourceIDs in interface UIDefinition

Returns:

The non-null list of data source IDs used for navigation on this UI, as found in the associated declarative UI definition.

getKeyLookupDatasourceID

public java.lang.String getKeyLookupDatasourceID()

Gets the non-null data source ID which acts as a separate instance from the main data source to handle the key change on this UI such as OE Order Entry, as found in the associated declarative UI definition.

Specified by:

getKeyLookupDatasourceID in interface UIDefinition

Returns:

The non-null data source ID which acts as a separate instance from the main data source to handle the key change on this UI, as found in the associated declarative UI definition.

getKeyWidgetIDs

public java.util.List<java.lang.String> getKeyWidgetIDs()

Gets the non-null list of key widget IDs on this UI, as found in the associated declarative UI definition.

Specified by:

getKeyWidgetIDs in interface UIDefinition

Returns:

The non-null list of key widget IDs on this UI, as found in the associated declarative UI definition.

getShortToLongNamespaces

public java.util.Map<java.lang.String,java.lang.String> getShortToLongNamespaces()

Gets the map of short to long namespaces for the UI definition context, as found in the associated declarative UI definition.

Specified by:

getShortToLongNamespaces in interface UIDefinition

Returns:

The map of short to long namespaces for the UI definition context, as found in the associated declarative UI definition. This map is unmodifiable.

setShortToLongNamespaces

public void setShortToLongNamespaces(java.util.Map<java.lang.String,java.lang.String> shortToLongNamespaces)

Sets the map of short to long namespaces for the UI definition context, as found in the associated declarative UI definition.

Parameters:

shortToLongNamespaces - The map of short to long namespaces for the UI definition context, as found in the associated declarative UI definition.

getScriptContents

public java.util.List<java.lang.String> getScriptContents()

Gets the list of script contents for the UI definition context, as found in the associated declarative UI definition and in external scripts specified in that declarative UI definition.

Specified by:

getScriptContents in interface UIDefinition

Returns:

The list of script contents for the UI definition context, as found in the associated declarative UI definition and in external scripts specified in that declarative UI definition. This list is unmodifiable.

setScriptContents

public void setScriptContents(java.util.List<java.lang.String> scriptContents)

Sets the list of script contents for the UI definition context, as found in the associated declarative UI definition and in external scripts specified in that declarative UI definition.

Parameters:

scriptContents - The list of script contents for the UI definition context, as found in the associated declarative UI definition and in external scripts specified in that declarative UI definition.

getStyleContents

public java.util.List<java.lang.String> getStyleContents()

Gets the list of style contents for the UI definition context, as found in the associated declarative UI definition and in external styles specified in that declarative UI definition.

Specified by:

getStyleContents in interface UIDefinition

Returns:

The list of style contents for the UI definition context, as found in the associated declarative UI definition and in external styles specified in that declarative UI definition. This list is unmodifiable.

setStyleContents

public void setStyleContents(java.util.List<java.lang.String> styleContents)

Sets the list of style contents for the UI definition context, as found in the associated declarative UI definition and in external styles specified in that declarative UI definition.

Parameters:

styleContents - The list of style contents for the UI definition context, as found in the associated declarative UI definition and in external styles specified in that declarative UI definition.

getConnectionsDefinition

public ConnectionsDefinition getConnectionsDefinition()

Gets the connections definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.

Specified by:

getConnectionsDefinition in interface UIDefinition

Returns:

The connections definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.

getPrefConnectionsDefinition

public ConnectionsDefinition getPrefConnectionsDefinition()

Gets the preference store connections definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.

Specified by:

getPrefConnectionsDefinition in interface UIDefinition

Returns:

The preference store connections definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.

getDataSourcesDefinition

public DataSourcesDefinition getDataSourcesDefinition()

Gets the datasources definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.

Specified by:

getDataSourcesDefinition in interface UIDefinition

Returns:

The datasources definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.

getPreferenceStoresDefinition

public DataSourcesDefinition getPreferenceStoresDefinition()

Gets the preferenceStore definition for the UI context, as found in the associated declarative UI definition

Specified by:

getPreferenceStoresDefinition in interface UIDefinition

Returns:

The preferenceStore datasources definition for the UI context, as found in the associated declarative UI definition definition.

setConnectionsDefinition

public void setConnectionsDefinition(ConnectionsDefinition connectionsDefinition)

Sets the connections definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.

Parameters:

connectionsDefinition - The connections definition for the UI context, as found in the associated declarative UI definition and in external declarative connections definitions specified in that declarative UI definition.

setPreferenceConnectionsDefinition

public void setPreferenceConnectionsDefinition(ConnectionsDefinition connectionsDefinition)

Sets the preference store connections definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.

Parameters:

connectionsDefinition - The preference store connections definition for the UI context, as found in the associated declarative UI definition and in external declarative connections definitions specified in that declarative UI definition.

setDataSourcesDefinition

public void setDataSourcesDefinition(DataSourcesDefinition dataSourcesDefinition)

Sets the datasources definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.

Parameters:

dataSourcesDefinition - The datasources definition for the UI context, as found in the associated declarative UI definition and in external declarative datasources definitions specified in that declarative UI definition.

setPreferenceStoresDefinition

public void setPreferenceStoresDefinition(DataSourcesDefinition preferenceStoresDefinition)

Sets the PreferenceStores datasources definitions for the UI context, as found in the associated declarative UI definition

Parameters:

preferenceStoresDefinition - The PreferenceStores datasources definitions for the UI context, as found in the associated declarative UI definition

getPopupElements

public java.util.List<com.google.gwt.xml.client.Element> getPopupElements()

Gets the popup form elements for the UI definition context, as found in the associated declarative UI definition.

Specified by:

getPopupElements in interface UIDefinition

Returns:

The popup form elements for the UI definition context, as found in the associated declarative UI definition.

setPopupElements

public void setPopupElements(java.util.List<com.google.gwt.xml.client.Element> popupElements)

Sets the popup form elements for the UI definition context, as found in the associated declarative UI definition.

Parameters:

popupElements - The popup form elements for the UI definition context, as found in the associated declarative UI definition.

getRootWidgetElement

public com.google.gwt.xml.client.Element getRootWidgetElement()

Gets the root widget for the UI definition context, as found in the associated declarative UI definition.

Specified by:

getRootWidgetElement in interface UIDefinition

Returns:

The root widget for the UI definition context, as found in the associated declarative UI definition.

setRootWidgetElement

public void setRootWidgetElement(com.google.gwt.xml.client.Element rootWidgetElement)

Sets the root widget for the UI definition context, as found in the associated declarative UI definition.

Parameters:

rootWidgetElement - The root widget for the UI definition context, as found in the associated declarative UI definition.

getHandlerElements

public java.util.List<com.google.gwt.xml.client.Element> getHandlerElements()

Gets the handler elements for the UI definition context, as found in the associated declarative UI definition.

Specified by:

getHandlerElements in interface UIDefinition

Returns:

The handler elements for the UI definition context, as found in the associated declarative UI definition.

setHandlerElements

public void setHandlerElements(java.util.List<com.google.gwt.xml.client.Element> handlerElements)

Sets the handler form elements for the UI definition context, as found in the associated declarative UI definition.

Parameters:

handlerElements - The handler elements for the UI definition context, as found in the associated declarative UI definition.

getTopicElements

public java.util.List<com.google.gwt.xml.client.Element> getTopicElements()

Gets the topic elements for the UI definition context, as found in the associated declarative UI definition.

Specified by:

getTopicElements in interface UIDefinition

Returns:

The topic elements for the UI definition context, as found in the associated declarative UI definition.

setTopicElements

public void setTopicElements(java.util.List<com.google.gwt.xml.client.Element> topicElements)

Sets the topic elements for the UI definition context, as found in the associated declarative UI definition.

Parameters:

topicElements - The topic elements for the UI definition context, as found in the associated declarative UI definition.

getMessages

public java.util.Map<java.lang.String,java.lang.String> getMessages()

Gets the map of messages for the UI definition context, as found in the associated declarative UI definition.

Specified by:

getMessages in interface UIDefinition

Returns:

The map of messages for the UI definition context, as found in the associated declarative UI definition. This map is unmodifiable.

setMessages

public void setMessages(java.util.Map<java.lang.String,java.lang.String> messages)

Sets the map of messages for the UI definition context, as found in the associated declarative UI definition.

Parameters:

messages - The map of messages for the UI definition context, as found in the associated declarative UI definition.

getApplicationMenuXML

public java.lang.String getApplicationMenuXML()

Description copied from interface: UIDefinition

Gets the XML of the applicationMenus section in the declarative UI definition used as a basis for creating this instance context.

Specified by:

getApplicationMenuXML in interface UIDefinition

Returns:

the XML of the applicationMenus section in the declarative UI definition used as a basis for creating this instance context.

setApplicationMenuXML

public void setApplicationMenuXML(java.lang.String menuXML)

Sets the XML for the applicationMenus section of the Ui Definition.

Parameters:

menuXML - the XML for the applicationMenus section of the UI Definition.