public final class UICommandRenderer extends Object implements ICollectionRendererParameterNameConst
LayoutObject
, set in the constructor to
retrieve all parametrization from the calling class. It then returns a Component
that is ready-to-use.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, PAGER_SHOW_NUMBER, 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
Constructor and Description |
---|
UICommandRenderer(ILayoutObject layoutObject,
IProxy proxy)
Deprecated.
As of NetWeaver 7.1
|
UICommandRenderer(IParameters parameters,
IProxy proxy)
Deprecated.
As of NetWeaver 7.1
|
UICommandRenderer(LayoutObject layoutObject,
IProxy proxy)
Deprecated.
As of NetWeaver 7.1
|
Modifier and Type | Method and Description |
---|---|
static com.sapportals.htmlb.Component |
getCommandIconComponent(IUIBaseCommand command,
IResource resource)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderAction(IResource res,
IParameterName parameterName)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderAsIcon(IResource res,
IParameterName parameterName)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderAsLink(IResource res,
IParameterName parameterName)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderCollectionAction(IResource res,
IParameterName parameterName)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderCommandContentLink(IResource resource,
String commandAlias,
com.sapportals.htmlb.Component comp)
Deprecated.
As of NetWeaver 7.1
|
com.sapportals.htmlb.Component |
renderMassAction(IResource res,
IParameterName parameterName)
Deprecated.
As of NetWeaver 7.1
|
public UICommandRenderer(IParameters parameters, IProxy proxy)
public UICommandRenderer(LayoutObject layoutObject, IProxy proxy)
layoutObject
- a layoutObject that holds all the parametrization to
create the correct rendering. Must not be null
.proxy
- the proxy that is used as the target control, when the
commands that are included in the returned Component
trigger Event
s.public UICommandRenderer(ILayoutObject layoutObject, IProxy proxy)
layoutObject
- a layoutObject that holds all the parametrization to
create the correct rendering. Must not be null
.proxy
- the proxy that is used as the target control, when the
commands that are included in the returned Component
trigger Event
s.public com.sapportals.htmlb.Component renderMassAction(IResource res, IParameterName parameterName) throws WcmException
IUIGroupCommand
defined for the given resource.res
- the resource IUIGroupCommand
is
needed for.parameterName
- the parameterName that specifies, which parameter
holds the information which groupcommand to renderComponent
that holds the defined
IUIGroupCommand
and its children as Components. This
method checks first, if the parameter with key IResourceRendererParameterNameConst.COLLECTION_ACTIONSTYLE
is set. If it is not set, the default IParameterNameConst.ACTIONSTYLE_HOVER
is used. If that parameter holds an invalid value, an empty TextView
is returned.WcmException
- Description of the Exceptionpublic com.sapportals.htmlb.Component renderCollectionAction(IResource res, IParameterName parameterName) throws WcmException
IUIGroupCommand
defined for the given resource.res
- the resource IUIGroupCommand
is
needed for.parameterName
- the parameterName that specifies, which parameter
holds the information which groupcommand to renderComponent
that holds the defined
IUIGroupCommand
and its children as Components. This
method checks first, if the parameter with key IResourceRendererParameterNameConst.COLLECTION_ACTIONSTYLE
is set. If it is not set, the default IParameterNameConst.ACTIONSTYLE_HOVER
is used. If that parameter holds an invalid value, an empty TextView
is returned.WcmException
- Description of the Exceptionpublic com.sapportals.htmlb.Component renderAction(IResource res, IParameterName parameterName) throws WcmException
IUIGroupCommand
defined for the given resource.res
- the resource IUIGroupCommand
is
needed for.parameterName
- the parameterName that specifies, which parameter
holds the information which groupcommand to renderComponent
that holds the defined
IUIGroupCommand
and its children as Components. This
method checks first, if the parameter with key IResourceRendererParameterNameConst.ITEMACTIONSTYLE
is set. If not, the key ICollectionRendererParameterNameConst.COLLECTION_ACTIONSTYLE
is read out. If it is not set either, the default IParameterNameConst.ACTIONSTYLE_HOVER
is used. If that parameter holds an invalid value, an empty TextView
is returned.WcmException
- Description of the Exceptionpublic com.sapportals.htmlb.Component renderAsLink(IResource res, IParameterName parameterName) throws WcmException
IUIGroupCommand
defined for the given resource as
a list of links.res
- the resource IUIGroupCommand
is
needed for.parameterName
- the parameterName that specifies, which parameter
holds the information which groupcommand to renderComponent
that holds the defined
IUIGroupCommand
and its children as Components. If the
configuration is invalid, an empty TextView
is returnedWcmException
- Description of the Exceptionpublic com.sapportals.htmlb.Component renderAsIcon(IResource res, IParameterName parameterName) throws WcmException
IUIGroupCommand
defined for the given resource as
a hover menu, opening from an icon.res
- the resource IUIGroupCommand
is
needed for.parameterName
- the parameterName that specifies, which parameter
holds the information which groupcommand to renderComponent
that holds the defined
IUIGroupCommand
and its children as Components. If the
configuration is invalid, an empty TextView
is returnedWcmException
- Description of the Exceptionpublic com.sapportals.htmlb.Component renderCommandContentLink(IResource resource, String commandAlias, com.sapportals.htmlb.Component comp)
resource
- resourcecommandAlias
- commandAliaspublic static final com.sapportals.htmlb.Component getCommandIconComponent(IUIBaseCommand command, IResource resource)
command
- commandresource
- resourceAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com]
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice