Skip navigation links

Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.0)
E10684-08


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

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.UIXShowDetail
                  extended by oracle.adf.view.rich.component.rich.layout.RichShowDetailHeader

All Implemented Interfaces:
javax.faces.component.StateHolder

public class RichShowDetailHeader
extends org.apache.myfaces.trinidad.component.UIXShowDetail

<html:p> The showDetailHeader provides a means of toggling the contents under a header between being disclosed(shown) or undisclosed(hidden). </html:p> <html:p> On mobile devices the showDetailHeader renders nothing itself, but does render its children. </html:p> <section name="Appearance"> <html:p> If the "disclosed" property on the showDetailHeader is set to false, the icon arrow will point sideways, and the children of the showDetailHeader will not be rendered. If the "disclosed" property of the showDetailHeader is set to true, the icon arrow will point down and the children of the showDetailHeader will be rendered. </html:p> </section> <section name="Attachment_Mode"> In Attachment Mode, contentDelivery will be forced to contentDelivery="immediate" </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> <section name="Events"> <html:p> Clicking on the icon of the showDetailHeader will deliver a DisclosureEvent to the server. </html:p> </section> <section name="Unsupported_Attributes"> <html:p> The disclosedTransient attribute is not supported by the rich client renderers and may only be used with the Apache MyFaces Trinidad RenderKit. If this attribute is set to true in an ADF page, the component will not function correctly. This attribute appears in ADF due to it being inherited from UIXShowDetail. The value must either not be set, or must be set to false, a value of true will cause problems. </html:p> </section>

Events:

Type Phases Description
org.apache.myfaces.trinidad.event.DisclosureEvent Apply Request Values
Invoke Application
The disclosure event is delivered when a node is disclosed.
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 java.lang.String CONTENT_DELIVERY_IMMEDIATE
           
static org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_KEY
           
static java.lang.String CONTENT_DELIVERY_LAZY_UNCACHED
           
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 DONT_PERSIST_KEY
           
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 org.apache.myfaces.trinidad.bean.PropertyKey MAXIMIZE_LISTENER_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey MAXIMIZED_KEY
           
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 PERSIST_KEY
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
           
static java.lang.String SHOW_MAXIMIZE_ALWAYS
           
static java.lang.String SHOW_MAXIMIZE_AUTO
           
static org.apache.myfaces.trinidad.bean.PropertyKey SHOW_MAXIMIZE_KEY
           
static java.lang.String SHOW_MAXIMIZE_NEVER
           
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.UIXShowDetail
DISCLOSED_KEY, DISCLOSED_TRANSIENT_KEY, DISCLOSURE_LISTENER_KEY, IMMEDIATE_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
  RichShowDetailHeader()
          Construct an instance of the RichShowDetailHeader.
protected RichShowDetailHeader(java.lang.String rendererType)
          Construct an instance of the RichShowDetailHeader.

 

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 getContentDelivery()
          Gets whether the undisclosed content is delivered with the initial page.
 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[] getDontPersist()
          Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
 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.el.MethodExpression getMaximizeListener()
          Gets a method reference to a maximize listener
 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[] getPersist()
          Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
 java.lang.String getShortDesc()
          Gets the short description of the component.
 java.lang.String getShowMaximize()
          Gets Whether to display the maximize control to allow this component to be maximized.
 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 isMaximized()
          Gets whether the children are currently maximized
 boolean isVisible()
          Gets the visibility of the component.
 void processDecodes(javax.faces.context.FacesContext context)
           
 void processUpdates(javax.faces.context.FacesContext context)
           
 void processValidators(javax.faces.context.FacesContext context)
           
 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 setContentDelivery(java.lang.String contentDelivery)
          Sets whether the undisclosed content is delivered with the initial page.
 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 setDontPersist(java.lang.String[] dontPersist)
          Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
 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 setMaximized(boolean maximized)
          Sets whether the children are currently maximized
 void setMaximizeListener(javax.el.MethodExpression maximizeListener)
          Sets a method reference to a maximize listener
 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 setPersist(java.lang.String[] persist)
          Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml.
 void setShortDesc(java.lang.String shortDesc)
          Sets the short description of the component.
 void setShowMaximize(java.lang.String showMaximize)
          Sets Whether to display the maximize control to allow this component to be maximized.
 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.UIXShowDetail
addDisclosureListener, broadcast, getDisclosureListener, getDisclosureListeners, getRenderedFacetsAndChildren, isDisclosed, isDisclosedTransient, isImmediate, queueEvent, removeDisclosureListener, setDisclosed, setDisclosedTransient, setDisclosureListener, setDisclosureListener, setImmediate

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, 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, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, 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

TYPE_DEFAULT

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

TYPE_FLOW

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

TYPE_STRETCH

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

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

SHOW_MAXIMIZE_NEVER

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

SHOW_MAXIMIZE_AUTO

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

SHOW_MAXIMIZE_ALWAYS

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

CONTENT_DELIVERY_IMMEDIATE

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

CONTENT_DELIVERY_LAZY_UNCACHED

public static final java.lang.String CONTENT_DELIVERY_LAZY_UNCACHED
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

UNSECURE_KEY

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

VISIBLE_KEY

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

CUSTOMIZATION_ID_KEY

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

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

TYPE_KEY

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

CONTENT_STYLE_KEY

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

HELP_TYPE_KEY

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

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

HEADER_LEVEL_KEY

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

PERSIST_KEY

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

DONT_PERSIST_KEY

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

MAXIMIZED_KEY

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

SHOW_MAXIMIZE_KEY

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

MAXIMIZE_LISTENER_KEY

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

CONTENT_DELIVERY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONTENT_DELIVERY_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

RichShowDetailHeader

public RichShowDetailHeader()
Construct an instance of the RichShowDetailHeader.

RichShowDetailHeader

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

Method Detail

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)
Overrides:
processDecodes in class org.apache.myfaces.trinidad.component.UIXComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)
Overrides:
processUpdates in class org.apache.myfaces.trinidad.component.UIXComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext context)
Overrides:
processValidators in class org.apache.myfaces.trinidad.component.UIXComponentBase

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. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
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. For components that support the helpTopicId attribute it is recommended that helpTopicId is used as it is more flexible and is more accessibility-compliant.
Parameters:
shortDesc - the new shortDesc value

getUnsecure

public final 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. Currently, this is supported only for the "disabled" attribute.
Returns:
the new unsecure value

setUnsecure

public final 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. Currently, this is supported only for the "disabled" attribute.
Parameters:
unsecure - the new unsecure 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

@Deprecated
public final java.lang.String getCustomizationId()
Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
Gets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
Returns:
the new customizationId value

setCustomizationId

@Deprecated
public final 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.
Sets This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
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 of an image to be displayed in the header. This attribute supports these various types of URIs: As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.
Returns:
the new icon value

setIcon

public final void setIcon(java.lang.String icon)
Sets the URI of an image to be displayed in the header. This attribute supports these various types of URIs: As icon does not allow alternative text to be provided for the image, in order to create an accessible product icon must only be used when its use is purely decorative.
Parameters:
icon - the new icon value

getType

public final java.lang.String getType()
Gets how the component will handle geometry management. Options are:
Returns:
the new type value

setType

public final void setType(java.lang.String type)
Sets how the component will handle geometry management. Options are:
Parameters:
type - the new type 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

@Deprecated
public final java.lang.String getHelpType()
Deprecated. helpType is deprecated, helpToicId should be used for providing help.
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

@Deprecated
public final void setHelpType(java.lang.String helpType)
Deprecated. helpType is deprecated, helpToicId should be used for providing help.
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 allows the default skinning size of the header to be overridden.

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.

Returns:
the new size value

setSize

public final void setSize(int size)
Sets allows the default skinning size of the header to be overridden.

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.

Parameters:
size - the new size value

getHeaderLevel

public final int getHeaderLevel()
Gets allows the default HTML header level assignment (H1 through H6) of the header to be overridden.

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.

Returns:
the new headerLevel value

setHeaderLevel

public final void setHeaderLevel(int headerLevel)
Sets allows the default HTML header level assignment (H1 through H6) of the header to be overridden.

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.

Parameters:
headerLevel - the new headerLevel value

getPersist

public final java.lang.String[] getPersist()
Gets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.
Returns:
the new persist value

setPersist

public final void setPersist(java.lang.String[] persist)
Sets a list of attributes whose changes are to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be included.
Parameters:
persist - the new persist value

getDontPersist

public final java.lang.String[] getDontPersist()
Gets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".
Returns:
the new dontPersist value

setDontPersist

public final void setDontPersist(java.lang.String[] dontPersist)
Sets a list of attributes whose changes are NOT to be persisted by FilteredPersistenceChangeManager via the "Persistent Change Manager" registered in adf-config.xml. The token 'ALL' can be used in the list here to indicate that all attribute changes that the component implicitly persists should be excluded. If there is a conflict of values, "dontPersist" always precedes "persist".
Parameters:
dontPersist - the new dontPersist value

isMaximized

public final boolean isMaximized()
Gets whether the children are currently maximized
Returns:
the new maximized value

setMaximized

public final void setMaximized(boolean maximized)
Sets whether the children are currently maximized
Parameters:
maximized - the new maximized value

getShowMaximize

public final java.lang.String getShowMaximize()
Gets Whether to display the maximize control to allow this component to be maximized. The default value, auto, allows the framework to determine whether the maximize control should be displayed beased on a number of factors, including the platform that the component is being displayed on.
Returns:
the new showMaximize value

setShowMaximize

public final void setShowMaximize(java.lang.String showMaximize)
Sets Whether to display the maximize control to allow this component to be maximized. The default value, auto, allows the framework to determine whether the maximize control should be displayed beased on a number of factors, including the platform that the component is being displayed on.
Parameters:
showMaximize - the new showMaximize value

getMaximizeListener

public final javax.el.MethodExpression getMaximizeListener()
Gets a method reference to a maximize listener
Returns:
the new maximizeListener value

setMaximizeListener

public final void setMaximizeListener(javax.el.MethodExpression maximizeListener)
Sets a method reference to a maximize listener
Parameters:
maximizeListener - the new maximizeListener value

getContentDelivery

public final java.lang.String getContentDelivery()
Gets whether the undisclosed content is delivered with the initial page. When contentDelivery is "immediate", the content is inlined into the initial page. If contentDelivery is "lazy", the content will be delivered to the client only after the first request to disclose the component. If contentDelivery is "lazyUncached", the content will be delivered each and every time the component's disclosure changes. By default, contentDelivery is lazyUncached.
Returns:
the new contentDelivery value

setContentDelivery

public final void setContentDelivery(java.lang.String contentDelivery)
Sets whether the undisclosed content is delivered with the initial page. When contentDelivery is "immediate", the content is inlined into the initial page. If contentDelivery is "lazy", the content will be delivered to the client only after the first request to disclose the component. If contentDelivery is "lazyUncached", the content will be delivered each and every time the component's disclosure changes. By default, contentDelivery is lazyUncached.
Parameters:
contentDelivery - the new contentDelivery value

getFamily

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

getBeanType

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

Skip navigation links

Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.0)
E10684-08


Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.