|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPanel
oracle.adf.view.rich.component.rich.layout.RichPanelHeader
public class RichPanelHeader
<html:p> The Header Panel control places a label and optional icon at the top of a section. </html:p> <html:p> On mobile devices the panelHeader renders nothing itself, but does renders its children. </html:p> <section name="panelHeader_and_Messaging_Information"> <html:p> The panelHeader can also be used at the top of an application page to give the user important messaging information. The types of messages, set by the <html:code>messageType</html:code> attribute are: <html:ul> <html:li>error</html:li> <html:li>information</html:li> <html:li>warning</html:li> <html:li>confirmation</html:li> </html:ul> </html:p> </section> <section name="Header_Size"> <html:p> panelHeader does not support setting the CSS style, but does support setting a size. A large header (H1 in HTML) corresponds to 0, medium to 1, and small to 2. Some render kits and skins support sizes up to 5 (equiv. H6 - HTML's maximum header value) but most renderkits and skins will only support up to 2 (in compliance with the BLAF and BLAF+ specs. Setting the header size to something greater then the supported value will style the header the same as the largest supported value (ie. size="6" will be displayed the same as either a size="5" if supported or a size="2"). </html:p> </section>
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 events might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
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 java.lang.String |
COMPONENT_FAMILY |
static java.lang.String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CONTENT_STYLE_KEY |
static java.lang.String |
CONTEXT_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY Deprecated. |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HEADER_LEVEL_KEY |
static java.lang.String |
HELP_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HELP_TOPIC_ID_KEY |
static java.lang.String |
HELP_TYPE_INLINE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HELP_TYPE_KEY Deprecated. |
static java.lang.String |
HELP_TYPE_LINK |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ICON_KEY |
static java.lang.String |
INFO_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static java.lang.String |
LEGEND_FACET |
static java.lang.String |
MENU_BAR_FACET |
static java.lang.String |
MESSAGE_TYPE_CONFIRMATION |
static java.lang.String |
MESSAGE_TYPE_ERROR |
static java.lang.String |
MESSAGE_TYPE_INFO |
static org.apache.myfaces.trinidad.bean.PropertyKey |
MESSAGE_TYPE_KEY |
static java.lang.String |
MESSAGE_TYPE_NONE |
static java.lang.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 org.apache.myfaces.trinidad.bean.PropertyKey |
SIZE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TEXT_KEY |
static java.lang.String |
TOOLBAR_FACET |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static java.lang.String |
TYPE_DEFAULT |
static java.lang.String |
TYPE_FLOW |
static org.apache.myfaces.trinidad.bean.PropertyKey |
TYPE_KEY |
static java.lang.String |
TYPE_STRETCH |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Fields inherited from class javax.faces.component.UIComponent |
---|
bindings |
Constructor Summary | |
---|---|
|
RichPanelHeader() Construct an instance of the RichPanelHeader. |
protected |
RichPanelHeader(java.lang.String rendererType) Construct an instance of the RichPanelHeader. |
Method Summary | |
---|---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
ClientListenerSet |
getClientListeners() Gets a set of client listeners. |
java.lang.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. |
java.lang.String |
getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
java.lang.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. |
java.lang.String |
getHelpTopicId() Gets the id used to look up a topic in a helpProvider. |
java.lang.String |
getHelpType() Deprecated. helpType is deprecated, helpToicId should be used for providing help. |
java.lang.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. |
java.lang.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. |
java.lang.String |
getMessageType() Gets whether an error, info, confirmation, or warning header is needed. |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
int |
getSize() Gets allows the default skinning size of the header to be overridden. |
java.lang.String |
getStyleClass() Gets a CSS style class to use for this component. |
java.lang.String |
getText() Gets the label of the header. |
javax.faces.component.UIComponent |
getToolbar() Toolbar component that is rendered on the header. |
java.lang.String |
getType() Gets how the component will handle geometry management. |
java.util.Set<java.lang.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(java.util.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(java.lang.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(java.lang.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(java.lang.String helpTopicId) Sets the id used to look up a topic in a helpProvider. |
void |
setHelpType(java.lang.String helpType) Deprecated. helpType is deprecated, helpToicId should be used for providing help. |
void |
setIcon(java.lang.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(java.lang.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(java.lang.String messageType) Sets whether an error, info, confirmation, or warning header is needed. |
void |
setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
void |
setShortDesc(java.lang.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(java.lang.String styleClass) Sets a CSS style class to use for this component. |
void |
setText(java.lang.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(java.lang.String type) Sets how the component will handle geometry management. |
void |
setUnsecure(java.util.Set<java.lang.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. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, 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, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, 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, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TYPE_DEFAULT
public static final java.lang.String TYPE_FLOW
public static final java.lang.String TYPE_STRETCH
public static final java.lang.String HELP_TYPE_INLINE
public static final java.lang.String HELP_TYPE_LINK
public static final java.lang.String MESSAGE_TYPE_INFO
public static final java.lang.String MESSAGE_TYPE_CONFIRMATION
public static final java.lang.String MESSAGE_TYPE_WARNING
public static final java.lang.String MESSAGE_TYPE_NONE
public static final java.lang.String MESSAGE_TYPE_ERROR
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 java.lang.String CONTEXT_FACET
public static final java.lang.String HELP_FACET
public static final java.lang.String TOOLBAR_FACET
public static final java.lang.String MENU_BAR_FACET
public static final java.lang.String LEGEND_FACET
public static final java.lang.String INFO_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichPanelHeader()
protected RichPanelHeader(java.lang.String rendererType)
Method Detail |
---|
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 java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic final java.lang.String getHelpTopicId()
public final void setHelpTopicId(java.lang.String helpTopicId)
helpTopicId
- the new helpTopicId valuepublic final java.lang.String getText()
This is a required property on the component.
public final void setText(java.lang.String text)
This is a required property on the component.
text
- the new text valuepublic final java.lang.String getIcon()
public final void setIcon(java.lang.String icon)
icon
- the new icon valuepublic final java.lang.String getType()
public final void setType(java.lang.String type)
type
- the new type valuepublic final java.lang.String getContentStyle()
public final void setContentStyle(java.lang.String contentStyle)
contentStyle
- the new contentStyle value
@Deprecated
public final java.lang.String getHelpType()
@Deprecated
public final void setHelpType(java.lang.String helpType)
helpType
- the new helpType valuepublic final java.lang.String getMessageType()
public final void setMessageType(java.lang.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 assignement 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 diferentiation, 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 assignement 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 diferentiation, 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 assignements 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 assignements 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 java.lang.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
|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |