Package org.opencms.ui.apps

Class A_CmsAttributeAwareApp

java.lang.Object

org.opencms.ui.apps.A_CmsWorkplaceApp

org.opencms.ui.apps.A_CmsAttributeAwareApp

All Implemented Interfaces:

I_CmsWorkplaceApp

Direct Known Subclasses:

CmsDbImportApp, CmsDbManager, CmsDbRemovePubLocksApp, CmsDbStaticExportApp, CmsDbSynchronizationApp, CmsModuleApp

public abstract class A_CmsAttributeAwareApp
extends A_CmsWorkplaceApp

An abstract subclass of A_CmsWorkplaceApp which provides an additional way for the main component of an app (the widget returned by getComponentForState) to influence the app layout of the app itself (i.e. the parts outside the main component). This is done using two methods: getAttributesForComponent is used to extract additiona

Nested Class Summary

Nested classes/interfaces inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

A_CmsWorkplaceApp.NavEntry

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ATTR_INFO_COMPONENT	Attribute for info.
static final String	ATTR_MAIN_HEIGHT_FULL	Attribute for full height.

Fields inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

m_infoLayout, m_rootLayout, m_uiContext, PARAM_ASSIGN, PARAM_SEPARATOR

Constructor Summary

Constructors

Constructor	Description
A_CmsAttributeAwareApp()

Method Summary

Modifier and Type	Method	Description
protected Map<String,Object>	getAttributesForComponent(com.vaadin.ui.Component component)	Gets the attributes from a given component.
void	openSubView(String state, boolean updateState)	Opens the requested sub view.
protected void	updateAppAttributes(Map<String,Object> attributes)	Handles the attributes.
void	updateMainComponent(com.vaadin.ui.Component comp)	Replaces the app's main component with the given component.

Methods inherited from class org.opencms.ui.apps.A_CmsWorkplaceApp

addParamToState, addSubNavEntry, getBreadCrumbForState, getComponentForState, getLastPathLevel, getOfflineCmsObject, getParamFromState, getParamsFromState, getSubNavEntries, initUI, onStateChange, removeParamsFromState, setBreadCrumbEntries, updateBreadCrumb, updateSubNav

Methods inherited from class java.lang.Object

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

Field Details

ATTR_INFO_COMPONENT

public static final String ATTR_INFO_COMPONENT

Attribute for info.

See Also:

• Constant Field Values

ATTR_MAIN_HEIGHT_FULL

public static final String ATTR_MAIN_HEIGHT_FULL

Attribute for full height.

See Also:

• Constant Field Values

Constructor Details

A_CmsAttributeAwareApp

public A_CmsAttributeAwareApp()

Method Details

openSubView

public void openSubView(String state,
 boolean updateState)

Opens the requested sub view.

Overrides:

openSubView in class A_CmsWorkplaceApp

Parameters:

state - the state

updateState - true to update the state URL token

updateMainComponent

public void updateMainComponent(com.vaadin.ui.Component comp)

Replaces the app's main component with the given component.

This also handles the attributes for the component, just as if the given component was returned by an app's getComponentForState method.

Parameters:

comp - the component to set as the main component

getAttributesForComponent

protected Map<String,Object> getAttributesForComponent(com.vaadin.ui.Component component)

Gets the attributes from a given component.

Parameters:

component - to read attributes from

Returns:

map of attributes

updateAppAttributes

protected void updateAppAttributes(Map<String,Object> attributes)

Handles the attributes.

Parameters:

attributes - to set