oracle.adf.view.faces.component.core.layout
Class CorePanelHeader

java.lang.Object
  javax.faces.component.UIComponent
      oracle.adf.view.faces.component.UIXComponent
          oracle.adf.view.faces.component.UIXComponentBase
              oracle.adf.view.faces.component.UIXPanel
                  oracle.adf.view.faces.component.core.layout.CorePanelHeader

All Implemented Interfaces:

StateHolder

public class CorePanelHeader

extends UIXPanel

The panelHeader control places a label and optional icon at the top of a section.

On mobile devices the panelHeader renders nothing itself, but does renders its children.

panelHeader and Messaging Information

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 messageType attribute are:

• error
• information
• warning
• confirmation

Header Size

panelHeader does not support setting the CSS style, but does support setting a size. A large header corresponds to 0, medium to 1, and small to 2.

Example:

Basic example.

     <af:panelHeader text="This is a panelHeader">
       <af:goLink text="Oracle" destination="http://www.oracle.com"/>
       <af:panelHeader text="This is a Sub-panelHeader" >
           <af:goLink text="Oracle" destination="http://www.oracle.com"/>
       </af:panelHeader>
     </af:panelHeader>

panelHeader displaying message information.

     <af:panelHeader messageType="error"/>

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	ICON_KEY
static PropertyKey	INLINE_STYLE_KEY
static java.lang.String	MESSAGE_TYPE_CONFIRMATION Enumerated value indicating that the control has a confirmation message
static java.lang.String	MESSAGE_TYPE_ERROR Enumerated value indicating that the control has an error message
static java.lang.String	MESSAGE_TYPE_INFO Enumerated value indicating that the control has an informational message
static PropertyKey	MESSAGE_TYPE_KEY
static java.lang.String	MESSAGE_TYPE_NONE Enumerated value indicating that the control has no associated message
static java.lang.String	MESSAGE_TYPE_WARNING Enumerated value indicating that the control has a warning message
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	PARTIAL_TRIGGERS_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	SHORT_TEXT_KEY
static PropertyKey	SIZE_KEY
static PropertyKey	STYLE_CLASS_KEY
static PropertyKey	TEXT_KEY
static FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

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

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
java.lang.String	getIcon() Gets the URI for the icon of the panelHeader.
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getMessageType() Gets Set if an error, info, confirmation, or warning header is needed.
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
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 bean.
java.lang.String	getShortText() Gets abbreviated text of the panelHeader
int	getSize() Gets Size of this panelHeader.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getText() Gets the label of the panelHeader.
void	setIcon(java.lang.String icon) Sets the URI for the icon of the panelHeader.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
void	setMessageType(java.lang.String messageType) Sets Set if an error, info, confirmation, or warning header is needed.
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
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 bean.
void	setShortText(java.lang.String shortText) Sets abbreviated text of the panelHeader
void	setSize(int size) Sets Size of this panelHeader.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setText(java.lang.String text) Sets the label of the panelHeader.

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addAttributeChange, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

MESSAGE_TYPE_INFO

public static final java.lang.String MESSAGE_TYPE_INFO

Enumerated value indicating that the control has an informational message

See Also:

Constant Field Values

MESSAGE_TYPE_CONFIRMATION

public static final java.lang.String MESSAGE_TYPE_CONFIRMATION

Enumerated value indicating that the control has a confirmation message

See Also:

Constant Field Values

MESSAGE_TYPE_WARNING

public static final java.lang.String MESSAGE_TYPE_WARNING

Enumerated value indicating that the control has a warning message

See Also:

Constant Field Values

MESSAGE_TYPE_NONE

public static final java.lang.String MESSAGE_TYPE_NONE

Enumerated value indicating that the control has no associated message

See Also:

Constant Field Values

MESSAGE_TYPE_ERROR

public static final java.lang.String MESSAGE_TYPE_ERROR

Enumerated value indicating that the control has an error message

See Also:

Constant Field Values

TYPE

public static final FacesBean.Type TYPE

TEXT_KEY

public static final PropertyKey TEXT_KEY

SHORT_TEXT_KEY

public static final PropertyKey SHORT_TEXT_KEY

ICON_KEY

public static final PropertyKey ICON_KEY

MESSAGE_TYPE_KEY

public static final PropertyKey MESSAGE_TYPE_KEY

SIZE_KEY

public static final PropertyKey SIZE_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

PARTIAL_TRIGGERS_KEY

public static final PropertyKey PARTIAL_TRIGGERS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

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

CorePanelHeader

public CorePanelHeader()

Construct an instance of the CorePanelHeader.

CorePanelHeader

protected CorePanelHeader(java.lang.String rendererType)

Construct an instance of the CorePanelHeader.

Method Detail

getText

public final java.lang.String getText()

Gets the label of the panelHeader.

setText

public final void setText(java.lang.String text)

Sets the label of the panelHeader.

getShortText

public final java.lang.String getShortText()

Gets abbreviated text of the panelHeader

setShortText

public final void setShortText(java.lang.String shortText)

Sets abbreviated text of the panelHeader

getIcon

public final java.lang.String getIcon()

Gets the URI for the icon of the panelHeader.

setIcon

public final void setIcon(java.lang.String icon)

Sets the URI for the icon of the panelHeader.

getMessageType

public final java.lang.String getMessageType()

Gets Set if an error, info, confirmation, or warning header is needed.

setMessageType

public final void setMessageType(java.lang.String messageType)

Sets Set if an error, info, confirmation, or warning header is needed.

getSize

public final int getSize()

Gets Size of this panelHeader. The largest is 0, the smallest is 2.

setSize

public final void setSize(int size)

Sets Size of this panelHeader. The largest is 0, the smallest is 2.

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

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.

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.

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getInlineStyle

public final java.lang.String getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)

Sets the inline CSS style for this element

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class UIXPanel

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXPanel