public class RichPanelHeader
extends org.apache.myfaces.trinidad.component.UIXPanel
implements javax.faces.component.behavior.ClientBehaviorHolder
Type | Phases | Description |
---|---|---|
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing. |
Modifier and Type | Field and Description |
---|---|
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_ATTRIBUTES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_COMPONENT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_LISTENERS_KEY |
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CONTENT_STYLE_KEY |
static String |
CONTEXT_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY
Deprecated.
|
static String |
HEADER_LEVEL_1 |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HEADER_LEVEL_KEY |
static String |
HEADER_LEVEL1 |
static String |
HEADER_LEVEL2 |
static String |
HEADER_LEVEL3 |
static String |
HEADER_LEVEL4 |
static String |
HEADER_LEVEL5 |
static String |
HEADER_LEVEL6 |
static String |
HELP_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HELP_TOPIC_ID_KEY |
static String |
HELP_TYPE_INLINE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HELP_TYPE_KEY
Deprecated.
|
static String |
HELP_TYPE_LINK |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ICON_KEY |
static String |
INFO_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static String |
LEGEND_FACET |
static String |
MENU_BAR_FACET |
static String |
MESSAGE_TYPE_CONFIRMATION |
static String |
MESSAGE_TYPE_ERROR |
static String |
MESSAGE_TYPE_INFO |
static org.apache.myfaces.trinidad.bean.PropertyKey |
MESSAGE_TYPE_KEY |
static String |
MESSAGE_TYPE_NONE |
static String |
MESSAGE_TYPE_WARNING |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static String |
SIZE_1 |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SIZE_KEY |
static String |
SIZE0 |
static String |
SIZE1 |
static String |
SIZE2 |
static String |
SIZE3 |
static String |
SIZE4 |
static String |
SIZE5 |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TEXT_KEY |
static String |
TOOLBAR_FACET |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static String |
TYPE_DEFAULT |
static String |
TYPE_FLOW |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TYPE_KEY |
static String |
TYPE_STRETCH |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
Modifier | Constructor and Description |
---|---|
|
RichPanelHeader()
Construct an instance of the RichPanelHeader.
|
protected |
RichPanelHeader(String rendererType)
Construct an instance of the RichPanelHeader.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
Set |
getClientAttributes()
Gets a set of client attribute names.
|
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
ClientListenerSet |
getClientListeners()
Gets a set of client listeners.
|
String |
getContentStyle()
Gets the inline style of the content region.
|
javax.faces.component.UIComponent |
getContext()
A Facet that can be used to display contextual information on the header.
|
String |
getCustomizationId()
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
String |
getDefaultEventName() |
Collection<String> |
getEventNames() |
String |
getFamily() |
int |
getHeaderLevel()
Gets allows the default HTML header level assignment (H1 through H6) of the header to be overridden.
|
javax.faces.component.UIComponent |
getHelp()
This facet is deprecated, helpTopicId should be used for providing help.
|
String |
getHelpTopicId()
Gets the id used to look up a topic in a helpProvider.
|
String |
getHelpType()
Deprecated.
helpType is deprecated, helpToicId should be used for providing help.
|
String |
getIcon()
Gets the URI of an image to be displayed in the header.
|
javax.faces.component.UIComponent |
getInfo()
A facet that displays addition information inside the header content.
|
String |
getInlineStyle()
Gets the CSS styles to use for this component.
|
javax.faces.component.UIComponent |
getLegend()
A Facet that can be used to display legend information on the header.
|
javax.faces.component.UIComponent |
getMenuBar()
MenuBar component that is rendered on the header.
|
String |
getMessageType()
Gets whether an error, info, confirmation, or warning header is needed.
|
String[] |
getPartialTriggers()
Gets the IDs of the components that should trigger a partial update.
|
String |
getShortDesc()
Gets the short description of the component.
|
int |
getSize()
Gets allows the default skinning size of the header to be overridden.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
String |
getText()
Gets the label of the header.
|
javax.faces.component.UIComponent |
getToolbar()
Toolbar component that is rendered on the header.
|
String |
getType()
Gets how the component will handle geometry management.
|
Set<String> |
getUnsecure()
Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
|
boolean |
isClientComponent()
Gets whether a client-side component will be generated.
|
boolean |
isVisible()
Gets the visibility of the component.
|
void |
setClientAttributes(Set clientAttributes)
Sets a set of client attribute names.
|
void |
setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated.
|
void |
setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
|
void |
setContentStyle(String contentStyle)
Sets the inline style of the content region.
|
void |
setContext(javax.faces.component.UIComponent contextFacet)
A Facet that can be used to display contextual information on the header.
|
void |
setCustomizationId(String customizationId)
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
void |
setHeaderLevel(int headerLevel)
Sets allows the default HTML header level assignment (H1 through H6) of the header to be overridden.
|
void |
setHelp(javax.faces.component.UIComponent helpFacet)
This facet is deprecated, helpTopicId should be used for providing help.
|
void |
setHelpTopicId(String helpTopicId)
Sets the id used to look up a topic in a helpProvider.
|
void |
setHelpType(String helpType)
Deprecated.
helpType is deprecated, helpToicId should be used for providing help.
|
void |
setIcon(String icon)
Sets the URI of an image to be displayed in the header.
|
void |
setInfo(javax.faces.component.UIComponent infoFacet)
A facet that displays addition information inside the header content.
|
void |
setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.
|
void |
setLegend(javax.faces.component.UIComponent legendFacet)
A Facet that can be used to display legend information on the header.
|
void |
setMenuBar(javax.faces.component.UIComponent menuBarFacet)
MenuBar component that is rendered on the header.
|
void |
setMessageType(String messageType)
Sets whether an error, info, confirmation, or warning header is needed.
|
void |
setPartialTriggers(String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update.
|
void |
setShortDesc(String shortDesc)
Sets the short description of the component.
|
void |
setSize(int size)
Sets allows the default skinning size of the header to be overridden.
|
void |
setStyleClass(String styleClass)
Sets a CSS style class to use for this component.
|
void |
setText(String text)
Sets the label of the header.
|
void |
setToolbar(javax.faces.component.UIComponent toolbarFacet)
Toolbar component that is rendered on the header.
|
void |
setType(String type)
Sets how the component will handle geometry management.
|
void |
setUnsecure(Set<String> unsecure)
Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
|
void |
setVisible(boolean visible)
Sets the visibility of the component.
|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final String TYPE_DEFAULT
public static final String TYPE_FLOW
public static final String TYPE_STRETCH
public static final String HELP_TYPE_INLINE
public static final String HELP_TYPE_LINK
public static final String MESSAGE_TYPE_INFO
public static final String MESSAGE_TYPE_CONFIRMATION
public static final String MESSAGE_TYPE_WARNING
public static final String MESSAGE_TYPE_NONE
public static final String MESSAGE_TYPE_ERROR
public static final String SIZE_1
public static final String SIZE0
public static final String SIZE1
public static final String SIZE2
public static final String SIZE3
public static final String SIZE4
public static final String SIZE5
public static final String HEADER_LEVEL_1
public static final String HEADER_LEVEL1
public static final String HEADER_LEVEL2
public static final String HEADER_LEVEL3
public static final String HEADER_LEVEL4
public static final String HEADER_LEVEL5
public static final String HEADER_LEVEL6
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ICON_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey TYPE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TYPE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MESSAGE_TYPE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SIZE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HEADER_LEVEL_KEY
public static final String CONTEXT_FACET
public static final String HELP_FACET
public static final String TOOLBAR_FACET
public static final String MENU_BAR_FACET
public static final String LEGEND_FACET
public static final String INFO_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public RichPanelHeader()
protected RichPanelHeader(String rendererType)
public final javax.faces.component.UIComponent getContext()
public final void setContext(javax.faces.component.UIComponent contextFacet)
public final javax.faces.component.UIComponent getHelp()
public final void setHelp(javax.faces.component.UIComponent helpFacet)
public final javax.faces.component.UIComponent getToolbar()
public final void setToolbar(javax.faces.component.UIComponent toolbarFacet)
public final javax.faces.component.UIComponent getMenuBar()
public final void setMenuBar(javax.faces.component.UIComponent menuBarFacet)
public final javax.faces.component.UIComponent getLegend()
public final void setLegend(javax.faces.component.UIComponent legendFacet)
public final javax.faces.component.UIComponent getInfo()
public final void setInfo(javax.faces.component.UIComponent infoFacet)
public final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
public final void setShortDesc(String shortDesc)
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final String getHelpTopicId()
public final void setHelpTopicId(String helpTopicId)
helpTopicId
- the new helpTopicId valuepublic final String getText()
This is a required property on the component.
public final void setText(String text)
This is a required property on the component.
text
- the new text valuepublic final String getIcon()
public final void setIcon(String icon)
icon
- the new icon valuepublic final String getType()
public final void setType(String type)
type
- the new type valuepublic final String getContentStyle()
public final void setContentStyle(String contentStyle)
contentStyle
- the new contentStyle value@Deprecated public final String getHelpType()
@Deprecated public final void setHelpType(String helpType)
helpType
- the new helpType valuepublic final String getMessageType()
public final void setMessageType(String messageType)
messageType
- the new messageType valuepublic final int getSize()
Sizes for skinning start at size 0 (the largest) and progress to size 5 (the smallest). The size is determined based on containment within other header components, and is accomplished via the assignment of skinning keys. For example, a header that is not contained by another header component will automatically be displayed as size 0. A child header contained inside this header would automatically be displayed as size 1.
The size attribute by default is -1, where the size is then calculated by containment as defined above. This is the preferred setting - it is recommended that you design your page nesting header components to take advantage of the automatically assigned sizes. Alternately, setting the size attribute to values 0 through 5 will force that size skinning value assignment on the header component, regardless of its containment with other header components on the page.
Please note that while header components support a total of six levels of skinning differentiation, less than this may be defined in your skin. Also, setting the header size to something greater then the supported value will style the header the same as the largest supported value. Please see the Skinning Selectors documentation for the assigned skinning keys used by the component.
public final void setSize(int size)
Sizes for skinning start at size 0 (the largest) and progress to size 5 (the smallest). The size is determined based on containment within other header components, and is accomplished via the assignment of skinning keys. For example, a header that is not contained by another header component will automatically be displayed as size 0. A child header contained inside this header would automatically be displayed as size 1.
The size attribute by default is -1, where the size is then calculated by containment as defined above. This is the preferred setting - it is recommended that you design your page nesting header components to take advantage of the automatically assigned sizes. Alternately, setting the size attribute to values 0 through 5 will force that size skinning value assignment on the header component, regardless of its containment with other header components on the page.
Please note that while header components support a total of six levels of skinning differentiation, less than this may be defined in your skin. Also, setting the header size to something greater then the supported value will style the header the same as the largest supported value. Please see the Skinning Selectors documentation for the assigned skinning keys used by the component.
size
- the new size valuepublic final int getHeaderLevel()
Header components are assigned HTML header level assignments of H1 through H6. (Similar to size) the header level assigned is determined based on containment within other header components. For example, a header that is not contained by another header component will automatically render as an H1 header level. A child header contained inside this header would automatically render as an H2 header level. While the display of header components is determined by the size skinning selector assigned, HTML header level is important for correct page structure, especially when used with screen reader applications.
The headerLevel attribute by default is -1, where the HTML header level is then calculated by containment as defined above. This is the preferred setting - it is recommended that you design your page nesting header components to take advantage of the automatically assigned header levels. Alternately, setting the headerLevel attribute to values 1 through 6 will force the corresponding HTML header level to render as part of the header component, regardless of its containment with other header components on the page.
Plesae be careful if overriding the header level! The HTML header level assignments (H1 through H6) controlled by this attribute are relied upon by screen reader applications to appropriately identify the underlying structure of the page. Make sure your use of header components and assignment of header levels make sense for your page. When using an override value, consider the effects of having headers inside disclosable sections of the page.
public final void setHeaderLevel(int headerLevel)
Header components are assigned HTML header level assignments of H1 through H6. (Similar to size) the header level assigned is determined based on containment within other header components. For example, a header that is not contained by another header component will automatically render as an H1 header level. A child header contained inside this header would automatically render as an H2 header level. While the display of header components is determined by the size skinning selector assigned, HTML header level is important for correct page structure, especially when used with screen reader applications.
The headerLevel attribute by default is -1, where the HTML header level is then calculated by containment as defined above. This is the preferred setting - it is recommended that you design your page nesting header components to take advantage of the automatically assigned header levels. Alternately, setting the headerLevel attribute to values 1 through 6 will force the corresponding HTML header level to render as part of the header component, regardless of its containment with other header components on the page.
Plesae be careful if overriding the header level! The HTML header level assignments (H1 through H6) controlled by this attribute are relied upon by screen reader applications to appropriately identify the underlying structure of the page. Make sure your use of header components and assignment of header levels make sense for your page. When using an override value, consider the effects of having headers inside disclosable sections of the page.
headerLevel
- the new headerLevel valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXPanel
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXPanel