Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal
Interface PortalPublicRenderParameters
public interface PortalPublicRenderParametersDefines the local and global names of the supported portal-specific portal render parameters.
- Since:
- 8.0
Field Summary static java.lang.String NAME_DEVICE_CLASS
Local name of the public render parameter that encodes the device class.static java.lang.String NAME_DIGEST
Local name of the public render parameter that encodes the digest.static java.lang.String NAME_EXPANSIONS
Local name of the public render parameter that encodes the page expansions.static java.lang.String NAME_FOCUS
Local name of the public render parameter that encodes the ID of the focussed elementstatic java.lang.String NAME_HIDDEN_CONTENT
Local name of the public render parameter that encodes the state of the hidden layout container.static java.lang.String NAME_HIDDEN_PAGES
Local name of the public render parameter that encodes the state of hidden pages.static java.lang.String NAME_LABEL_MAPPINGS
Local name of the public render parameter that encodes the label mappings.static java.lang.String NAME_LOCALE
Local name of the public render parameter that encodes the locale.static java.lang.String NAME_PAGE_EDIT_MODE
Local name of the public render parameter that encodes the page edit mode.static java.lang.String NAME_PAGE_HELP_MODE
Local name of the public render parameter that encodes the page help mode.static java.lang.String NAME_PAGE_INFO_MODE
Local name of the public render parameter that encodes the page info mode.static java.lang.String NAME_PAGE_MODE
Local name of the public render parameter that encodes the page modes that are currently active.static java.lang.String NAME_PARAMETERS
Local name of the public render parameter that encodes the selection parameters.static java.lang.String NAME_PATH_INFO
Local name of the public render parameter that encodes the path-info portion of the URL.static java.lang.String NAME_SCREEN_TEMPLATE
Local name of the public render parameter that encodes the screen template.static java.lang.String NAME_SELECTION
Local name of the public render parameter that encodes the page selection.static java.lang.String NAME_SHOW_TOOLS
Local name of the public render parameter that encodes the show tools state.static java.lang.String NAME_SOLO
Local name of the public render parameter that encodes the solo state.static java.lang.String NAME_STATE_PARTITION
Local name of the public render parameter that encodes the state partition.static java.lang.String NAME_THEME_POLICY
Local name of the public render parameter that encodes the theme policy.static java.lang.String NAME_THEME_TEMPLATE
Local name of the public render parameter that encodes the theme template.static java.lang.String NAME_URI
Local name of the public render parameter that encodes a URI that is to be resolved by the portal.static java.lang.String NAMESPACE_URI
Namespace for portal-specific public render parametersstatic javax.xml.namespace.QName QNAME_DEVICE_CLASS
Qualified name of the public render parameter that encodes the device class.static javax.xml.namespace.QName QNAME_DIGEST
Qualified name of the public render parameter that encodes the digest.static javax.xml.namespace.QName QNAME_EXPANSIONS
Qualified name of the public render parameter that encodes a set of ObjectID that represent the page expansionsstatic javax.xml.namespace.QName QNAME_FOCUS
Qualified name of the public render parameter that encodes the focussed elementstatic javax.xml.namespace.QName QNAME_HIDDEN_CONTENT
Qualified name of the public render parameter that encodes the state of the hidden layout container.static javax.xml.namespace.QName QNAME_HIDDEN_PAGES
Qualified name of the public render parameter that encodes the state of hidden pages.static javax.xml.namespace.QName QNAME_LABEL_MAPPINGS
Qualified name of the public render parameter that encodes the label mappings.static javax.xml.namespace.QName QNAME_LOCALE
Qualified name of the public render parameter that encodes the locale.static javax.xml.namespace.QName QNAME_PAGE_EDIT_MODE
Qualified name of the public render parameter that encodes the page edit mode.static javax.xml.namespace.QName QNAME_PAGE_HELP_MODE
Qualified name of the public render parameter that encodes the page help mode.static javax.xml.namespace.QName QNAME_PAGE_INFO_MODE
Qualified name of the public render parameter that encodes the page info mode.static javax.xml.namespace.QName QNAME_PAGE_MODE
Qualified name of the public render parameter that encodes the page modes that are currently active.static javax.xml.namespace.QName QNAME_PARAMETERS
Qualified name of the public render parameter that encodes the selection parameters.static javax.xml.namespace.QName QNAME_PATH_INFO
Qualified name of the public render parameter that encodes the path-info portion of the URLstatic javax.xml.namespace.QName QNAME_SCREEN_TEMPLATE
Qualified name of the public render parameter that encodes the screen template.static javax.xml.namespace.QName QNAME_SELECTION
Qualified name of the public render parameter that encodes the ObjectID or the unique name of the page selection.static javax.xml.namespace.QName QNAME_SHOW_TOOLS
Qualified name of the public render parameter that encodes the show tools state.static javax.xml.namespace.QName QNAME_SOLO
Qualified name of the public render parameter that encodes the solo state.static javax.xml.namespace.QName QNAME_STATE_PARTITION
Qualified name of the public render parameter that encodes the state partition.static javax.xml.namespace.QName QNAME_THEME_POLICY
Qualified name of the public render parameter that encodes the theme policy.static javax.xml.namespace.QName QNAME_THEME_TEMPLATE
Qualified name of the public render parameter that encodes the theme template.static javax.xml.namespace.QName QNAME_TOOLBAR_SELECTION
Qualified name of the public render parameter that encodes the page selection of the toolbar.static javax.xml.namespace.QName QNAME_URI
Qualified name of public render parameter that encodes a URI that is to be resolved by the portal.static UnmodifiableSet<javax.xml.namespace.QName> QNAMES
Access to all portal-specific QName values as a Set.static UnmodifiableSet<javax.xml.namespace.QName> QNAMES_TOOLBAR
Access to all portal-specific QName values as a Set.static java.lang.String TOOLBAR_NAMESPACE_URI
Namespace for all toolbar-specific public render parameters
Field Detail NAMESPACE_URI
static final java.lang.String NAMESPACE_URI
- Namespace for portal-specific public render parameters
- See Also:
- Constant Field Values
NAME_EXPANSIONS
static final java.lang.String NAME_EXPANSIONS
- Local name of the public render parameter that encodes the page expansions.
- Since:
- 8.5
- See Also:
- Constant Field Values
QNAME_EXPANSIONS
static final javax.xml.namespace.QName QNAME_EXPANSIONS
- Qualified name of the public render parameter that encodes a set of ObjectID that represent the page expansions
- Since:
- 8.5
NAME_SELECTION
static final java.lang.String NAME_SELECTION
- Local name of the public render parameter that encodes the page selection.
- See Also:
- Constant Field Values
QNAME_SELECTION
static final javax.xml.namespace.QName QNAME_SELECTION
- Qualified name of the public render parameter that encodes the ObjectID or the unique name of the page selection.
NAME_URI
static final java.lang.String NAME_URI
- Local name of the public render parameter that encodes a URI that is to be resolved by the portal.
- See Also:
- Constant Field Values
QNAME_URI
static final javax.xml.namespace.QName QNAME_URI
- Qualified name of public render parameter that encodes a URI that is to be resolved by the portal.
NAME_PARAMETERS
static final java.lang.String NAME_PARAMETERS
- Local name of the public render parameter that encodes the selection parameters.
- See Also:
- Constant Field Values
QNAME_PARAMETERS
static final javax.xml.namespace.QName QNAME_PARAMETERS
- Qualified name of the public render parameter that encodes the selection parameters. The parameters are a set of name value pairs with a string as key and a string array as values. The mapping of this structure to the value of the public render parameters is as follows:
- the name value pairs are separated by a null string
- for each name value pair the first string in the sequence denotes the key. The following strings up to the next null string or the end of the array denote the values.
NAME_LOCALE
static final java.lang.String NAME_LOCALE
- Local name of the public render parameter that encodes the locale.
- See Also:
- Constant Field Values
QNAME_LOCALE
static final javax.xml.namespace.QName QNAME_LOCALE
- Qualified name of the public render parameter that encodes the locale.
NAME_THEME_TEMPLATE
static final java.lang.String NAME_THEME_TEMPLATE
- Local name of the public render parameter that encodes the theme template.
- See Also:
- Constant Field Values
QNAME_THEME_TEMPLATE
static final javax.xml.namespace.QName QNAME_THEME_TEMPLATE
- Qualified name of the public render parameter that encodes the theme template.
NAME_LABEL_MAPPINGS
static final java.lang.String NAME_LABEL_MAPPINGS
- Local name of the public render parameter that encodes the label mappings.
- See Also:
- Constant Field Values
QNAME_LABEL_MAPPINGS
static final javax.xml.namespace.QName QNAME_LABEL_MAPPINGS
- Qualified name of the public render parameter that encodes the label mappings.
NAME_SCREEN_TEMPLATE
static final java.lang.String NAME_SCREEN_TEMPLATE
- Local name of the public render parameter that encodes the screen template.
- See Also:
- Constant Field Values
QNAME_SCREEN_TEMPLATE
static final javax.xml.namespace.QName QNAME_SCREEN_TEMPLATE
- Qualified name of the public render parameter that encodes the screen template.
NAME_THEME_POLICY
static final java.lang.String NAME_THEME_POLICY
- Local name of the public render parameter that encodes the theme policy.
- See Also:
- Constant Field Values
QNAME_THEME_POLICY
static final javax.xml.namespace.QName QNAME_THEME_POLICY
- Qualified name of the public render parameter that encodes the theme policy.
NAME_SOLO
static final java.lang.String NAME_SOLO
- Local name of the public render parameter that encodes the solo state.
- See Also:
- Constant Field Values
QNAME_SOLO
static final javax.xml.namespace.QName QNAME_SOLO
- Qualified name of the public render parameter that encodes the solo state. The value is the ObjectID of the portlet in solo mode.
NAME_SHOW_TOOLS
static final java.lang.String NAME_SHOW_TOOLS
- Local name of the public render parameter that encodes the show tools state. The value is true or false;
- See Also:
- Constant Field Values
QNAME_SHOW_TOOLS
static final javax.xml.namespace.QName QNAME_SHOW_TOOLS
- Qualified name of the public render parameter that encodes the show tools state.
NAME_HIDDEN_CONTENT
static final java.lang.String NAME_HIDDEN_CONTENT
- Local name of the public render parameter that encodes the state of the hidden layout container. The value is true or false.
- See Also:
- Constant Field Values
QNAME_HIDDEN_CONTENT
static final javax.xml.namespace.QName QNAME_HIDDEN_CONTENT
- Qualified name of the public render parameter that encodes the state of the hidden layout container.
NAME_HIDDEN_PAGES
static final java.lang.String NAME_HIDDEN_PAGES
- Local name of the public render parameter that encodes the state of hidden pages. The value is true or false.
- See Also:
- Constant Field Values
QNAME_HIDDEN_PAGES
static final javax.xml.namespace.QName QNAME_HIDDEN_PAGES
- Qualified name of the public render parameter that encodes the state of hidden pages.
NAME_STATE_PARTITION
static final java.lang.String NAME_STATE_PARTITION
- Local name of the public render parameter that encodes the state partition.
- See Also:
- Constant Field Values
QNAME_STATE_PARTITION
static final javax.xml.namespace.QName QNAME_STATE_PARTITION
- Qualified name of the public render parameter that encodes the state partition.
NAME_PATH_INFO
static final java.lang.String NAME_PATH_INFO
- Local name of the public render parameter that encodes the path-info portion of the URL. The value of the parameter is a string array. Each element in the array represents one path segment. The empty string array has the special meaning and means that the friendly part of the URL path is to be used as the value for this parameter. In contrast to the non-existing parameter which explicitly means that no path info exists.
- See Also:
- Constant Field Values
QNAME_PATH_INFO
static final javax.xml.namespace.QName QNAME_PATH_INFO
- Qualified name of the public render parameter that encodes the path-info portion of the URL
NAME_FOCUS
static final java.lang.String NAME_FOCUS
- Local name of the public render parameter that encodes the ID of the focussed element
- Since:
- 8.5
- See Also:
- Constant Field Values
QNAME_FOCUS
static final javax.xml.namespace.QName QNAME_FOCUS
- Qualified name of the public render parameter that encodes the focussed element
- Since:
- 8.5
NAME_DEVICE_CLASS
static final java.lang.String NAME_DEVICE_CLASS
- Local name of the public render parameter that encodes the device class.
- See Also:
- Constant Field Values
QNAME_DEVICE_CLASS
static final javax.xml.namespace.QName QNAME_DEVICE_CLASS
- Qualified name of the public render parameter that encodes the device class.
NAME_DIGEST
static final java.lang.String NAME_DIGEST
- Local name of the public render parameter that encodes the digest.
- See Also:
- Constant Field Values
QNAME_DIGEST
static final javax.xml.namespace.QName QNAME_DIGEST
- Qualified name of the public render parameter that encodes the digest.
NAME_PAGE_MODE
static final java.lang.String NAME_PAGE_MODE
- Local name of the public render parameter that encodes the page modes that are currently active.
- See Also:
- Constant Field Values
QNAME_PAGE_MODE
static final javax.xml.namespace.QName QNAME_PAGE_MODE
- Qualified name of the public render parameter that encodes the page modes that are currently active. The value is an array, each array entry describes a mode that is active. The modes do not appear in any particular order.
NAME_PAGE_EDIT_MODE
static final java.lang.String NAME_PAGE_EDIT_MODE
- Local name of the public render parameter that encodes the page edit mode.
- See Also:
- Constant Field Values
QNAME_PAGE_EDIT_MODE
static final javax.xml.namespace.QName QNAME_PAGE_EDIT_MODE
- Qualified name of the public render parameter that encodes the page edit mode. The value is true or false.
NAME_PAGE_INFO_MODE
static final java.lang.String NAME_PAGE_INFO_MODE
- Local name of the public render parameter that encodes the page info mode.
- See Also:
- Constant Field Values
QNAME_PAGE_INFO_MODE
static final javax.xml.namespace.QName QNAME_PAGE_INFO_MODE
- Qualified name of the public render parameter that encodes the page info mode. The value is true or false.
NAME_PAGE_HELP_MODE
static final java.lang.String NAME_PAGE_HELP_MODE
- Local name of the public render parameter that encodes the page help mode.
- See Also:
- Constant Field Values
QNAME_PAGE_HELP_MODE
static final javax.xml.namespace.QName QNAME_PAGE_HELP_MODE
- Qualified name of the public render parameter that encodes the page help mode. The value is true or false.
QNAMES
static final UnmodifiableSet<javax.xml.namespace.QName> QNAMES
- Access to all portal-specific QName values as a Set. The names only address those public render parameters that refer to explicitly modeled navigational state information. This set must NOT contain names that address public render parameters that are encoded as shared parameters in the state (e.g. the path info parameter).
- Since:
- 8.5
TOOLBAR_NAMESPACE_URI
static final java.lang.String TOOLBAR_NAMESPACE_URI
- Namespace for all toolbar-specific public render parameters
- See Also:
- Constant Field Values
QNAME_TOOLBAR_SELECTION
static final javax.xml.namespace.QName QNAME_TOOLBAR_SELECTION
- Qualified name of the public render parameter that encodes the page selection of the toolbar.
QNAMES_TOOLBAR
static final UnmodifiableSet<javax.xml.namespace.QName> QNAMES_TOOLBAR
- Access to all portal-specific QName values as a Set. The names only address those public render parameters that refer to explicitly modeled navigational state information incl. those that are part of the toolbar namespace. This set must NOT contain names that address public render parameters that are encoded as shared parameters in the state (e.g. the path info parameter).
- Since:
- 8.5
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD