Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-01


oracle.adf.view.rich.component.rich.layout
Class RichPanelHeader

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXPanel
                  extended by oracle.adf.view.rich.component.rich.layout.RichPanelHeader

All Implemented Interfaces:
javax.faces.component.StateHolder

public class RichPanelHeader
extends org.apache.myfaces.trinidad.component.UIXPanel

<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> <section name="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component that stretches its children, e.g., panelStretchLayout.</html:li> <html:li>This component does not stretch its children.</html:li> </html:ul> </section>

Events:

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
           
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
           
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 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()
          Gets The id used to locate this component when applying persistent customizations.
 java.lang.String getFamily()
           
 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()
          Gets Along with the help facet this is deprecated, helpTopicId should be used for providing help.
 java.lang.String getIcon()
          Gets the URI for the icon of 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 the size of this header.
 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.
 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)
          Sets The id used to locate this component when applying persistent customizations.
 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)
          Sets Along with the help facet this is deprecated, helpTopicId should be used for providing help.
 void setIcon(java.lang.String icon)
          Sets the URI for the icon of 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 the size of this header.
 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 setVisible(boolean visible)
          Sets the visibility of the component.

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, 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
processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren

 

Methods inherited from class javax.faces.component.UIComponent
getContainerClientId, invokeOnComponent

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

HELP_TYPE_INLINE

public static final java.lang.String HELP_TYPE_INLINE
See Also:
Constant Field Values

HELP_TYPE_LINK

public static final java.lang.String HELP_TYPE_LINK
See Also:
Constant Field Values

MESSAGE_TYPE_INFO

public static final java.lang.String MESSAGE_TYPE_INFO
See Also:
Constant Field Values

MESSAGE_TYPE_CONFIRMATION

public static final java.lang.String MESSAGE_TYPE_CONFIRMATION
See Also:
Constant Field Values

MESSAGE_TYPE_WARNING

public static final java.lang.String MESSAGE_TYPE_WARNING
See Also:
Constant Field Values

MESSAGE_TYPE_NONE

public static final java.lang.String MESSAGE_TYPE_NONE
See Also:
Constant Field Values

MESSAGE_TYPE_ERROR

public static final java.lang.String MESSAGE_TYPE_ERROR
See Also:
Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

VISIBLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY

CUSTOMIZATION_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY

CLIENT_COMPONENT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY

CLIENT_ATTRIBUTES_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY

PARTIAL_TRIGGERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY

CLIENT_LISTENERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY

HELP_TOPIC_ID_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TOPIC_ID_KEY

TEXT_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey TEXT_KEY

ICON_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ICON_KEY

CONTENT_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_STYLE_KEY

HELP_TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HELP_TYPE_KEY

MESSAGE_TYPE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MESSAGE_TYPE_KEY

SIZE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SIZE_KEY

CONTEXT_FACET

public static final java.lang.String CONTEXT_FACET
See Also:
Constant Field Values

HELP_FACET

public static final java.lang.String HELP_FACET
See Also:
Constant Field Values

TOOLBAR_FACET

public static final java.lang.String TOOLBAR_FACET
See Also:
Constant Field Values

MENU_BAR_FACET

public static final java.lang.String MENU_BAR_FACET
See Also:
Constant Field Values

LEGEND_FACET

public static final java.lang.String LEGEND_FACET
See Also:
Constant Field Values

INFO_FACET

public static final java.lang.String INFO_FACET
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

Constructor Detail

RichPanelHeader

public RichPanelHeader()
Construct an instance of the RichPanelHeader.

RichPanelHeader

protected RichPanelHeader(java.lang.String rendererType)
Construct an instance of the RichPanelHeader.

Method Detail

getContext

public final javax.faces.component.UIComponent getContext()
A Facet that can be used to display contextual information on the header. The contextual information is displayed next to the header text

setContext

public final void setContext(javax.faces.component.UIComponent contextFacet)
A Facet that can be used to display contextual information on the header. The contextual information is displayed next to the header text

getHelp

public final javax.faces.component.UIComponent getHelp()
This facet is deprecated, helpTopicId should be used for providing help. Both help facet when rendered inline and helpTopicId with instructions text are rendered in the same spot, so if helpTopicId is specified and it has instructions text, the help facet will not be rendered if specified inline. Help content that is displayed to the user. The content of the help is displayed inline inside the header content or as a popup through a link. The attribute helpType controls whether the help is displayed inline or in a popup.

setHelp

public final void setHelp(javax.faces.component.UIComponent helpFacet)
This facet is deprecated, helpTopicId should be used for providing help. Both help facet when rendered inline and helpTopicId with instructions text are rendered in the same spot, so if helpTopicId is specified and it has instructions text, the help facet will not be rendered if specified inline. Help content that is displayed to the user. The content of the help is displayed inline inside the header content or as a popup through a link. The attribute helpType controls whether the help is displayed inline or in a popup.

getToolbar

public final javax.faces.component.UIComponent getToolbar()
Toolbar component that is rendered on the header.

setToolbar

public final void setToolbar(javax.faces.component.UIComponent toolbarFacet)
Toolbar component that is rendered on the header.

getMenuBar

public final javax.faces.component.UIComponent getMenuBar()
MenuBar component that is rendered on the header.

setMenuBar

public final void setMenuBar(javax.faces.component.UIComponent menuBarFacet)
MenuBar component that is rendered on the header.

getLegend

public final javax.faces.component.UIComponent getLegend()
A Facet that can be used to display legend information on the header. If the help facet has a child and it is visible, the contents of the legend facet will be rendered beneath the task stamps. If the legend facet is not visible or no children exist, then it gets rendered below the title.

setLegend

public final void setLegend(javax.faces.component.UIComponent legendFacet)
A Facet that can be used to display legend information on the header. If the help facet has a child and it is visible, the contents of the legend facet will be rendered beneath the task stamps. If the legend facet is not visible or no children exist, then it gets rendered below the title.

getInfo

public final javax.faces.component.UIComponent getInfo()
A facet that displays addition information inside the header content. This informtion is displayed end aligned under the header

setInfo

public final void setInfo(javax.faces.component.UIComponent infoFacet)
A facet that displays addition information inside the header content. This informtion is displayed end aligned under the header

getInlineStyle

public final java.lang.String getInlineStyle()
Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()
Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Parameters:
styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()
Gets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which 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.
Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets the short description of the component. This text is commonly used by user agents to display tooltip help text, in which 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.
Parameters:
shortDesc - the new shortDesc value

isVisible

public final boolean isVisible()
Gets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Returns:
the new visible value

setVisible

public final void setVisible(boolean visible)
Sets the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property.
Parameters:
visible - the new visible value

getCustomizationId

public final java.lang.String getCustomizationId()
Gets The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document.
Returns:
the new customizationId value

setCustomizationId

public final void setCustomizationId(java.lang.String customizationId)
Sets The id used to locate this component when applying persistent customizations. Components without a customizationId set can not save customizations to the persistent store. Instead, any customizations will at most only apply to the current Session. Each customizationId must be unique in the document.
Parameters:
customizationId - the new customizationId value

isClientComponent

public final boolean isClientComponent()
Gets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Returns:
the new clientComponent value

setClientComponent

public final void setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary.
Parameters:
clientComponent - the new clientComponent value

getClientAttributes

public final java.util.Set getClientAttributes()
Gets a set of client attribute names.
Returns:
the new clientAttributes value

setClientAttributes

public final void setClientAttributes(java.util.Set clientAttributes)
Sets a set of client attribute names.
Parameters:
clientAttributes - the new clientAttributes value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
Parameters:
partialTriggers - the new partialTriggers value

getClientListeners

public final ClientListenerSet getClientListeners()
Gets a set of client listeners.
Returns:
the new clientListeners value

setClientListeners

public final void setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
Parameters:
clientListeners - the new clientListeners value

getHelpTopicId

public final java.lang.String getHelpTopicId()
Gets the id used to look up a topic in a helpProvider.
Returns:
the new helpTopicId value

setHelpTopicId

public final void setHelpTopicId(java.lang.String helpTopicId)
Sets the id used to look up a topic in a helpProvider.
Parameters:
helpTopicId - the new helpTopicId value

getText

public final java.lang.String getText()
Gets the label of the header.

This is a required property on the component.

Returns:
the new text value

setText

public final void setText(java.lang.String text)
Sets the label of the header.

This is a required property on the component.

Parameters:
text - the new text value

getIcon

public final java.lang.String getIcon()
Gets the URI for the icon of the header.
Returns:
the new icon value

setIcon

public final void setIcon(java.lang.String icon)
Sets the URI for the icon of the header.
Parameters:
icon - the new icon value

getContentStyle

public final java.lang.String getContentStyle()
Gets the inline style of the content region.
Returns:
the new contentStyle value

setContentStyle

public final void setContentStyle(java.lang.String contentStyle)
Sets the inline style of the content region.
Parameters:
contentStyle - the new contentStyle value

getHelpType

public final java.lang.String getHelpType()
Gets Along with the help facet this is deprecated, helpTopicId should be used for providing help. Controls if the help is displayed inline or as a link to a popup.
Returns:
the new helpType value

setHelpType

public final void setHelpType(java.lang.String helpType)
Sets Along with the help facet this is deprecated, helpTopicId should be used for providing help. Controls if the help is displayed inline or as a link to a popup.
Parameters:
helpType - the new helpType value

getMessageType

public final java.lang.String getMessageType()
Gets whether an error, info, confirmation, or warning header is needed.
Returns:
the new messageType value

setMessageType

public final void setMessageType(java.lang.String messageType)
Sets whether an error, info, confirmation, or warning header is needed.
Parameters:
messageType - the new messageType value

getSize

public final int getSize()
Gets the size of this header. The largest is 0 and corresponds to an H1 header the smallest is 5 and corresponds to an H6 Header. Note that this version of the tag will display all sizes above 2 the same as size 2. Setting the size to a negative number will allow the header to be calculated according to its parent header. The default value for this property is -1.
Returns:
the new size value

setSize

public final void setSize(int size)
Sets the size of this header. The largest is 0 and corresponds to an H1 header the smallest is 5 and corresponds to an H6 Header. Note that this version of the tag will display all sizes above 2 the same as size 2. Setting the size to a negative number will allow the header to be calculated according to its parent header. The default value for this property is -1.
Parameters:
size - the new size value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class org.apache.myfaces.trinidad.component.UIXPanel

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class org.apache.myfaces.trinidad.component.UIXPanel

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1)
E10684-01


Copyright © 1998, 2008, Oracle. All rights reserved.