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

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.CorePanelPageHeader

All Implemented Interfaces:

StateHolder

public class CorePanelPageHeader

extends UIXPanel

PanelPageHeader lays out the top portion of a page.

Example:

             <af:panelPageHeader>
               <f:facet name="branding">
                 <af:objectImage source="/components/images/corporateBrand.gif"/>
               </f:facet>
               <f:facet name="brandingApp">
                 <af:objectImage source="/components/images/applicationBrand.gif"/>
               </f:facet>
               <f:facet name="brandingAppContextual">
                 <af:outputFormatted value="Customer &lt;b&gt;Contextual Application Branding - Menlo Park&lt;/b&gt;"
                                    styleUsage="inContextBranding"/>
               </f:facet>
               <f:facet name="menuGlobal">
                 <af:menuButtons>
                   <af:commandMenuItem text="Help"
                                     icon="/components/images/globalhelp.gif"
                                     action="guide.menuButtons"/>
                   <af:commandMenuItem text="Help 2"
                                     icon="/components/images/globalhelp.gif"
                                     action="guide.menuButtons"/>
                 </af:menuButtons>
               </f:facet>
               <f:facet name="menu2">
                 <af:menuBar >
                   <af:commandMenuItem text="item 1" action="guide.menuBar" 
                                    selected="true" />
                 </af:menuBar>
               </f:facet>
             </af:panelPageHeader>
 

Field Summary

static java.lang.String	BRANDING_APP_CONTEXTUAL_FACET
static java.lang.String	BRANDING_APP_FACET
static java.lang.String	BRANDING_FACET
static java.lang.String	CHROME_TYPE_COMPACT Enumerated value indicating that the chromeType is the compact type.
static java.lang.String	CHROME_TYPE_EXPANDED Enumerated value indicating that the chromeType is the expanded type.
static PropertyKey	CHROME_TYPE_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	INLINE_STYLE_KEY
static java.lang.String	MENU_GLOBAL_FACET
static java.lang.String	MENU_SWITCH_FACET
static java.lang.String	MENU1_FACET
static java.lang.String	MENU2_FACET
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 java.lang.String	SEARCH_FACET
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	STYLE_CLASS_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

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

Method Summary

protected FacesBean.Type	getBeanType()
UIComponent	getBranding() The corporate or organization branding region of the page.
UIComponent	getBrandingApp() The application, module, or product branding region of the page.
UIComponent	getBrandingAppContextual() The application's contextual branding region of the page.
java.lang.String	getChromeType() Gets what the chromeType is for the page: compact or expanded.
java.lang.String	getFamily()
java.lang.String	getInlineStyle() Gets the inline CSS style for this element
UIComponent	getMenu1() This location typically contains a menuTabs.
UIComponent	getMenu2() This location typically contains a menuBar.
UIComponent	getMenuGlobal() This section typically contains a menuButtons.
UIComponent	getMenuSwitch() This location typically contains a menuChoice.
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.
UIComponent	getSearch() The search region of the page.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
void	setBranding(UIComponent brandingFacet) The corporate or organization branding region of the page.
void	setBrandingApp(UIComponent brandingAppFacet) The application, module, or product branding region of the page.
void	setBrandingAppContextual(UIComponent brandingAppContextualFacet) The application's contextual branding region of the page.
void	setChromeType(java.lang.String chromeType) Sets what the chromeType is for the page: compact or expanded.
void	setInlineStyle(java.lang.String inlineStyle) Sets the inline CSS style for this element
void	setMenu1(UIComponent menu1Facet) This location typically contains a menuTabs.
void	setMenu2(UIComponent menu2Facet) This location typically contains a menuBar.
void	setMenuGlobal(UIComponent menuGlobalFacet) This section typically contains a menuButtons.
void	setMenuSwitch(UIComponent menuSwitchFacet) This location typically contains a menuChoice.
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	setSearch(UIComponent searchFacet) The search region of the page.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.

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

CHROME_TYPE_COMPACT

public static final java.lang.String CHROME_TYPE_COMPACT

Enumerated value indicating that the chromeType is the compact type.

See Also:

Constant Field Values

CHROME_TYPE_EXPANDED

public static final java.lang.String CHROME_TYPE_EXPANDED

Enumerated value indicating that the chromeType is the expanded type.

See Also:

Constant Field Values

TYPE

public static final FacesBean.Type TYPE

CHROME_TYPE_KEY

public static final PropertyKey CHROME_TYPE_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

MENU1_FACET

public static final java.lang.String MENU1_FACET

See Also:

Constant Field Values

MENU2_FACET

public static final java.lang.String MENU2_FACET

See Also:

Constant Field Values

MENU_GLOBAL_FACET

public static final java.lang.String MENU_GLOBAL_FACET

See Also:

Constant Field Values

MENU_SWITCH_FACET

public static final java.lang.String MENU_SWITCH_FACET

See Also:

Constant Field Values

BRANDING_FACET

public static final java.lang.String BRANDING_FACET

See Also:

Constant Field Values

BRANDING_APP_FACET

public static final java.lang.String BRANDING_APP_FACET

See Also:

Constant Field Values

BRANDING_APP_CONTEXTUAL_FACET

public static final java.lang.String BRANDING_APP_CONTEXTUAL_FACET

See Also:

Constant Field Values

SEARCH_FACET

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

CorePanelPageHeader

public CorePanelPageHeader()

Construct an instance of the CorePanelPageHeader.

CorePanelPageHeader

protected CorePanelPageHeader(java.lang.String rendererType)

Construct an instance of the CorePanelPageHeader.

Method Detail

getMenu1

public final UIComponent getMenu1()

This location typically contains a menuTabs.

setMenu1

public final void setMenu1(UIComponent menu1Facet)

This location typically contains a menuTabs.

getMenu2

public final UIComponent getMenu2()

This location typically contains a menuBar.

setMenu2

public final void setMenu2(UIComponent menu2Facet)

This location typically contains a menuBar.

getMenuGlobal

public final UIComponent getMenuGlobal()

This section typically contains a menuButtons.

setMenuGlobal

public final void setMenuGlobal(UIComponent menuGlobalFacet)

This section typically contains a menuButtons.

getMenuSwitch

public final UIComponent getMenuSwitch()

This location typically contains a menuChoice. This child is not supported on the following agent types: pda, phone, voice.

setMenuSwitch

public final void setMenuSwitch(UIComponent menuSwitchFacet)

This location typically contains a menuChoice. This child is not supported on the following agent types: pda, phone, voice.

getBranding

public final UIComponent getBranding()

The corporate or organization branding region of the page. This section typically contains a medium size objectImage of the logo of the organization owning the page.

setBranding

public final void setBranding(UIComponent brandingFacet)

The corporate or organization branding region of the page. This section typically contains a medium size objectImage of the logo of the organization owning the page.

getBrandingApp

public final UIComponent getBrandingApp()

The application, module, or product branding region of the page. This section typically contains a objectImage of the application logo.

setBrandingApp

public final void setBrandingApp(UIComponent brandingAppFacet)

The application, module, or product branding region of the page. This section typically contains a objectImage of the application logo.

getBrandingAppContextual

public final UIComponent getBrandingAppContextual()

The application's contextual branding region of the page. This section typically contains formatted text indicating that ONE context exists between the persistent tabs. The user selects the context from a centralized aggregate home page of multiple contexts, then navigates into a tabbed application pertaining to that specific context. This child is not supported on the following agent types: pda, phone, voice.

setBrandingAppContextual

public final void setBrandingAppContextual(UIComponent brandingAppContextualFacet)

The application's contextual branding region of the page. This section typically contains formatted text indicating that ONE context exists between the persistent tabs. The user selects the context from a centralized aggregate home page of multiple contexts, then navigates into a tabbed application pertaining to that specific context. This child is not supported on the following agent types: pda, phone, voice.

getSearch

public final UIComponent getSearch()

The search region of the page. This child is not supported on the following agent types: pda, phone, voice.

setSearch

public final void setSearch(UIComponent searchFacet)

The search region of the page. This child is not supported on the following agent types: pda, phone, voice.

getChromeType

public final java.lang.String getChromeType()

Gets what the chromeType is for the page: compact or expanded. If compact, the productBranding will be shown alongside the corporate branding instead of below the corporate branding.

setChromeType

public final void setChromeType(java.lang.String chromeType)

Sets what the chromeType is for the page: compact or expanded. If compact, the productBranding will be shown alongside the corporate branding instead of below the corporate branding.

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