com.sapportals.wcm.rendering.layout

Class AbstractLayoutController

java.lang.Object
  com.sapportals.wcm.rendering.layout.AbstractLayoutController

All Implemented Interfaces:

ICollectionRendererParameterNameConst, ILayoutComponent, ILayoutController, IParameterNameConst, IResourceRendererParameterNameConst

public abstract class AbstractLayoutController

extends Object

implements ILayoutController, IParameterNameConst

Abstract class to implement some convenience methods for new implementations of the ILayoutController.

Field Summary

protected Control[]

controls The controls which are to be rendered by the extending class.

Fields inherited from interface com.sapportals.wcm.repository.service.layout.customizing.IParameterNameConst

ACTIONSTYLE_BUTTON, ACTIONSTYLE_HOVER, ACTIONSTYLE_ICON, ACTIONSTYLE_LINK, ACTIONSTYLE_MENU, ACTIONSTYLE_OFF, ACTIONSTYLE_SMALLBUTTON, ACTIONSTYLE_TOOLBAR_BUTTON, ACTIONSTYLE_VERTICAL_LINK, BASE_SETTINGS, COLLECTION_RENDERER_SETTINGS, FLAVOR, RESOURCE_RENDERER_SETTINGS, SETNAME, UI_GROUP_DETAILS, UI_LAYOUT_CONTROLLER, VALUE_OFF

Fields inherited from interface com.sapportals.wcm.repository.service.layout.customizing.ICollectionRendererParameterNameConst

BACKGROUNDIMAGEPATH, BACKGROUNDIMAGESTYLE, BACKGROUNDIMAGESTYLE_MULTIPLE, BACKGROUNDIMAGESTYLE_SINGLE, BREADCRUMBSTYLE, BREADCRUMBSTYLE_BACK, BREADCRUMBSTYLE_DRPODOWN, BREADCRUMBSTYLE_HORIZONTAL, BREADCRUMBSTYLE_OFF, BREADCRUMBSTYLE_VERTICAL, BREADCRUMBVISIBILITYSTYLE, BREADCRUMBVISIBILITYSTYLE_DISABLEROOT, BREADCRUMBVISIBILITYSTYLE_INVISIBLE, BREADCRUMBVISIBILITYSTYLE_INVISIBLEROOT, BREADCRUMBVISIBILITYSTYLE_NOICON, BREADCRUMBVISIBILITYSTYLE_STANDARD, COLLECTION_ACTIONSTYLE, COLLECTION_ACTIONSTYLE_BUTTON, COLLECTION_ACTIONSTYLE_HOVER, COLLECTION_ACTIONSTYLE_LINK, COLLECTION_ACTIONSTYLE_MENU, COLLECTION_ACTIONSTYLE_OFF, COLLECTION_ACTIONSTYLE_SMALLBUTTON, COLLECTION_ACTIONSTYLE_TOOLBAR_BUTTON, COLUMNS, COLUMNSPACING, COLUMNSPACINGSTYLE, COLUMNSPACINGSTYLE_FIXED, COLUMNSPACINGSTYLE_MINIMUM, COMPONENTS, EMPTY_COLLECTION_FILE, EMPTY_COLLECTION_KEY, EMPTY_COLLECTION_STYLE, EMPTY_COLLECTION_STYLE_MESSAGE, EMPTY_COLLECTION_STYLE_OFF, EMPTY_COLLECTION_STYLE_TEXT, FILESELECTIONMODE_MULTIPLE, FILESELECTIONMODE_SINGLE, FILTEREXTENSION, FILTERMIMETYPE, FILTERRESOURCETYPE, FOLDERSELECTIONMODE_MULTIPLE, FOLDERSELECTIONMODE_SINGLE, GRIDORDERSTYLE, GRIDORDERSTYLE_COLUMN_MAJOR, GRIDORDERSTYLE_ROW_MAJOR, GROUP_STYLE, GROUP_STYLE_OFF, GROUP_STYLE_PRIMARYCOLOR, GROUP_STYLE_SAPCOLOR, GROUP_STYLE_SECONDARYBOX, GROUP_STYLE_SECONDARYBOXCOLOR, GROUP_STYLE_SECONDARYCOLOR, HEADER_TEXT_STYLE, HTML_FILENAME, IMAGEMAP, ITEMSELECTIONMODE, ITEMSELECTIONMODE_MULTIPLE, ITEMSELECTIONMODE_OFF, ITEMSELECTIONMODE_SINGLE, LINKSSTYLE, LINKSSTYLE_ALL, LINKSSTYLE_EXTERNAL, LINKSSTYLE_INTERNAL, LINKSSTYLE_OFF, LINKSSTYLE_VISIBLE, MASSACTIONSTYLE, MASSACTIONSTYLE_BUTTON, MASSACTIONSTYLE_HOVER, MASSACTIONSTYLE_ICON, MASSACTIONSTYLE_LINK, MASSACTIONSTYLE_MENU, MASSACTIONSTYLE_OFF, MASSACTIONSTYLE_SMALLBUTTON, MASSACTIONSTYLE_TOOLBAR_BUTTON, MASSACTIONSTYLE_VERTICAL_LINK, MAX_NUM_OF_TABS, NO_OF_CHILD_FOR_NODE, NO_TAB_CONTENT, OPEN_NODES_STYLE, OPEN_NODES_STYLE_All, OPEN_NODES_STYLE_LAST_SELECTED, OPENTARGETTYPE, OPENTARGETTYPE_FIXED, OPENTARGETTYPE_NEW, OPENTARGETTYPE_OFF, OPENTARGETTYPE_SELF, PAGER_LINK_COUNT, PROPERTY_COLUMN_HEADER_STYLE, PROPERTY_COLUMN_HEADER_STYLE_LIST, PROPERTY_COLUMN_HEADER_STYLE_MENUE, PROPERTY_COLUMN_HEADER_STYLE_OFF, PROPERTY_COLUMN_HEADER_STYLE_TABLE, PROPERTY_COLUMN_HEADER_STYLE_TRANSPARENT, PROPERTYCOLUMNS, RESIZEHEIGHTSTYLE, RESIZEHEIGHTSTYLE_COMPACT, RESIZEHEIGHTSTYLE_OFF, RESIZEHEIGHTSTYLE_STRETCH, RESIZEWIDHTSTYLE, RESIZEWIDHTSTYLE_COMPACT, RESIZEWIDHTSTYLE_OFF, RESIZEWIDHTSTYLE_STRETCH, RESOURCE_LIST_FILTER, RESOURCE_LIST_FILTER_DEFAULT, ROWBACKGROUNDSTYLE, ROWS, ROWSPACING, ROWSPACINGSTYLE, ROWSPACINGSTYLE_ALTERNATING, ROWSPACINGSTYLE_BACKGROUND, ROWSPACINGSTYLE_COLUMNALTERNATING, ROWSPACINGSTYLE_COLUMNSEPARATED, ROWSPACINGSTYLE_FIXED, ROWSPACINGSTYLE_LINESEPARATED, ROWSPACINGSTYLE_MINIMUM, ROWSPACINGSTYLE_ROWALTERNATING, ROWSPACINGSTYLE_TRANSPARENT, SHOW_HIDDEN, SHOW_TREE_ROOT_NODE, SHOWFILESSTYLE, SHOWFILESSTYLE_ALL, SHOWFILESSTYLE_NOLINK, SHOWFILESSTYLE_OFF, SHOWFILESTYLE_ONLYLINK, SHOWFOLDERSSTYLE, SHOWFOLDERSSTYLE_ALL, SHOWFOLDERSSTYLE_NOLINK, SHOWFOLDERSSTYLE_OFF, SHOWFOLDERSSTYLE_ONLYLINK, SHOWFOLDERTITLE, SHOWUSERID, SHOWUSERNAME, SORT_ENABLED, SORT_ORDER, SORT_ORDER_ASCENDING, SORT_ORDER_DESCENDING, SORT_PROPERTY, TAB_BODY_FLAVOR, TAB_STYLE_SAFE, UI_COLL_RENDERER, UI_GROUP_COLLECTION, UI_GROUP_MASS, USE_SCROLL_CONTAINER, VERTICAL_ALIGNMENT, VERTICAL_ALIGNMENT_BASELINE, VERTICAL_ALIGNMENT_BOTTOM, VERTICAL_ALIGNMENT_MIDDLE, VERTICAL_ALIGNMENT_TOP

Fields inherited from interface com.sapportals.wcm.repository.service.layout.customizing.IResourceRendererParameterNameConst

CHILDFOLDERDELIMITER, CHILDFOLDERSTYLE, CHILDFOLDERSTYLE_HORIZONTAL, CHILDFOLDERSTYLE_OFF, CHILDFOLDERSTYLE_VERTICAL, FILE_IMAGE, FOLDER_IMAGE, FORCE_CHILDFOLDER_READ, HIGHLIGHTEDTEXTSTYLE, HIGHLIGHTEDTEXTSTYLE_DEFAULT, HIGHLIGHTEDTEXTSTYLE_EMPHASIZED, HIGHLIGHTEDTEXTSTYLE_HEADER1, HIGHLIGHTEDTEXTSTYLE_HEADER2, HIGHLIGHTEDTEXTSTYLE_HEADER3, HIGHLIGHTEDTEXTSTYLE_HEADER4, HIGHLIGHTEDTEXTSTYLE_LABEL, HIGHLIGHTEDTEXTSTYLE_LABELSMALL, HIGHLIGHTEDTEXTSTYLE_LEGEND, HIGHLIGHTEDTEXTSTYLE_REFERENCE, ICONHEIGHT, ICONSTYLE, ICONSTYLE_OFF, ICONSTYLE_REPLACE_ICON, ICONSTYLE_TARGET_ICON, ICONWIDTH, IMAGEHEIGHT, IMAGESTYLE, IMAGESTYLE_OFF, IMAGESTYLE_REPLACE, IMAGEWIDTH, ITEMACTIONSTYLE, ITEMACTIONSTYLE_BUTTON, ITEMACTIONSTYLE_HOVER, ITEMACTIONSTYLE_ICON, ITEMACTIONSTYLE_LINK, ITEMACTIONSTYLE_MENU, ITEMACTIONSTYLE_OFF, ITEMACTIONSTYLE_SMALLBUTTON, ITEMACTIONSTYLE_TOOLBAR_BUTTON, ITEMACTIONSTYLE_VERTICAL_LINK, ITEMHEIGHT, ITEMWIDTH, LINK_IMAGE, MAXCHILDFOLDERS, OPENTARGET, OPENTARGETTYPE, OPENTARGETTYPE_FIXED, OPENTARGETTYPE_LINK_LIST, OPENTARGETTYPE_NEW, OPENTARGETTYPE_OFF, OPENTARGETTYPE_SELF, PRIMARYTEXTSTYLE, PRIMARYTEXTSTYLE_DEFAULT, PRIMARYTEXTSTYLE_EMPHASIZED, PRIMARYTEXTSTYLE_HEADER1, PRIMARYTEXTSTYLE_HEADER2, PRIMARYTEXTSTYLE_HEADER3, PRIMARYTEXTSTYLE_HEADER4, PRIMARYTEXTSTYLE_LABEL, PRIMARYTEXTSTYLE_LABELSMALL, PRIMARYTEXTSTYLE_LEGEND, PRIMARYTEXTSTYLE_REFERENCE, PROPERTY_MODIFIERS, SECONDARYTEXTSTYLE, SECONDARYTEXTSTYLE_DEFAULT, SECONDARYTEXTSTYLE_EMPHASIZED, SECONDARYTEXTSTYLE_HEADER1, SECONDARYTEXTSTYLE_HEADER2, SECONDARYTEXTSTYLE_HEADER3, SECONDARYTEXTSTYLE_HEADER4, SECONDARYTEXTSTYLE_LABEL, SECONDARYTEXTSTYLE_LABELSMALL, SECONDARYTEXTSTYLE_LEGEND, SECONDARYTEXTSTYLE_REFERENCE, SHOW_MAX_NUMBER_OF_CATEGORIES, SHOWCHILDCOUNTSTYLE, SHOWCHILDCOUNTSTYLE_BOTH, SHOWCHILDCOUNTSTYLE_FILES, SHOWCHILDCOUNTSTYLE_FOLDERS, SHOWCHILDCOUNTSTYLE_OFF, SHOWCHILDCOUNTSTYLE_SUM, SHOWRESOURCEPROPERTIESSTYLE, SHOWRESOURCEPROPERTIESSTYLE_ALL, SHOWRESOURCEPROPERTIESSTYLE_OFF, TOOLTIPSTYLE, TOOLTIPSTYLE_OFF, TOOLTIPSTYLE_PATH, TOOLTIPSTYLE_TECHNICAL_NAME, UI_GROUP_FOLDER, UI_GROUP_LINK, UI_GROUP_RESOURCE, UI_RES_RENDERER, VISIBLEPROPERTIES, XMLFORMS_LIST_ITEM_RENDERER

Constructor Summary

AbstractLayoutController()

Method Summary

Control[]	getControls() returns all conrols that have to be registered with the Wdf-Framework.
IProxy	getProxy() returns the proxy that has been set when instantiating the class.
Component	render() This method has to be implemented by the extending layoutcontroller, if its output is to be seen by the user
void	setProxy(IProxy proxy) sets the proxy-attribute for the layout-controller.
protected void	writeDebugInformation() adds information about its rendering to the IProxy's debug list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sapportals.wcm.rendering.layout.ILayoutController

getNewInstance

Field Detail

controls

protected Control[] controls

The controls which are to be rendered by the extending class.

Constructor Detail

AbstractLayoutController

public AbstractLayoutController()

Method Detail

getControls

public Control[] getControls()

Description copied from interface: ILayoutController

returns all conrols that have to be registered with the Wdf-Framework. If a control within the ILayoutController is not returned via this method, it can not use the Wdf-functionalities such as persistence of simple data types or the use of the WdfEventDispatcher to create Link or Button elements.

Specified by:

getControls in interface ILayoutController

Returns:

an array of all controls inside the layoutcontroller that are to be registered with the WDF. The array must not contain null.

render

public Component render()
                 throws WdfException

This method has to be implemented by the extending layoutcontroller, if its output is to be seen by the user

Specified by:

render in interface ILayoutController

Returns:

an htmlb-Component that is to be displayed to the user

Throws:

WdfException

setProxy

public void setProxy(IProxy proxy)

Description copied from interface: ILayoutComponent

sets the proxy-attribute for the layout-controller. The proxy has to be passed to classes within the ILayoutController, which want to use the proxy's services.

Specified by:

setProxy in interface ILayoutComponent

getProxy

public IProxy getProxy()

returns the proxy that has been set when instantiating the class.

writeDebugInformation

protected void writeDebugInformation()

adds information about its rendering to the IProxy's debug list. The IProxy offers this functionality to all classes involved in the rendeirng process. This abstract class adds the list of the Controls rendered.