org.apache.myfaces.trinidad.component.core.layout
Class CorePanelPageHeader

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 org.apache.myfaces.trinidad.component.core.layout.CorePanelPageHeader
All Implemented Interfaces:
EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class CorePanelPageHeader
extends UIXPanel
implements javax.faces.component.behavior.ClientBehaviorHolder

PanelPageHeader lays out the top portion of a page.

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 event might include the width of a column that supported client-side resizing.


Field Summary
static String BRANDING_APP_CONTEXTUAL_FACET
           
static String BRANDING_APP_FACET
           
static String BRANDING_FACET
           
static String CHROME_TYPE_COMPACT
           
static String CHROME_TYPE_EXPANDED
           
static PropertyKey CHROME_TYPE_KEY
           
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static PropertyKey INLINE_STYLE_KEY
           
static String MENU_SWITCH_FACET
           
static String NAVIGATION_GLOBAL_FACET
           
static String NAVIGATION1_FACET
           
static String NAVIGATION2_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 String SEARCH_FACET
           
static PropertyKey SHORT_DESC_KEY
           
static PropertyKey STYLE_CLASS_KEY
           
static FacesBean.Type TYPE
           
 
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
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY
 
Constructor Summary
  CorePanelPageHeader()
          Construct an instance of the CorePanelPageHeader.
protected CorePanelPageHeader(String rendererType)
          Construct an instance of the CorePanelPageHeader.
 
Method Summary
 void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
          Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.
protected  FacesBean.Type getBeanType()
           
 javax.faces.component.UIComponent getBranding()
          The corporate or organization branding region of the page.
 javax.faces.component.UIComponent getBrandingApp()
          The application, module, or product branding region of the page.
 javax.faces.component.UIComponent getBrandingAppContextual()
          The application's contextual branding region of the page.
 String getChromeType()
          Gets what the chromeType is for the page: compact or expanded.
 Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
          Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.
 String getDefaultEventName()
          Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.
 Collection<String> getEventNames()
           
 String getFamily()
           
 String getInlineStyle()
          Gets the CSS styles to use for this component.
 javax.faces.component.UIComponent getMenuSwitch()
          This location typically contains a menuChoice.
 javax.faces.component.UIComponent getNavigation1()
          This location typically contains a menuTabs.
 javax.faces.component.UIComponent getNavigation2()
          This location typically contains a menuBar.
 javax.faces.component.UIComponent getNavigationGlobal()
          This section typically contains a menuButtons.
 String getOnclick()
          Gets an onclick Javascript handler.
 String getOndblclick()
          Gets an ondblclick Javascript handler.
 String getOnkeydown()
          Gets an onkeydown Javascript handler.
 String getOnkeypress()
          Gets an onkeypress Javascript handler.
 String getOnkeyup()
          Gets an onkeyup Javascript handler.
 String getOnmousedown()
          Gets an onmousedown Javascript handler.
 String getOnmousemove()
          Gets an onmousemove Javascript handler.
 String getOnmouseout()
          Gets an onmouseout Javascript handler.
 String getOnmouseover()
          Gets an onmouseover Javascript handler.
 String getOnmouseup()
          Gets an onmouseup Javascript handler.
 String[] getPartialTriggers()
          Gets the IDs of the components that should trigger a partial update.
 javax.faces.component.UIComponent getSearch()
          The search region of the page.
 String getShortDesc()
          Gets The short description of the component.
 String getStyleClass()
          Gets a CSS style class to use for this component.
 void setBranding(javax.faces.component.UIComponent brandingFacet)
          The corporate or organization branding region of the page.
 void setBrandingApp(javax.faces.component.UIComponent brandingAppFacet)
          The application, module, or product branding region of the page.
 void setBrandingAppContextual(javax.faces.component.UIComponent brandingAppContextualFacet)
          The application's contextual branding region of the page.
 void setChromeType(String chromeType)
          Sets what the chromeType is for the page: compact or expanded.
 void setInlineStyle(String inlineStyle)
          Sets the CSS styles to use for this component.
 void setMenuSwitch(javax.faces.component.UIComponent menuSwitchFacet)
          This location typically contains a menuChoice.
 void setNavigation1(javax.faces.component.UIComponent navigation1Facet)
          This location typically contains a menuTabs.
 void setNavigation2(javax.faces.component.UIComponent navigation2Facet)
          This location typically contains a menuBar.
 void setNavigationGlobal(javax.faces.component.UIComponent navigationGlobalFacet)
          This section typically contains a menuButtons.
 void setOnclick(String onclick)
          Sets an onclick Javascript handler.
 void setOndblclick(String ondblclick)
          Sets an ondblclick Javascript handler.
 void setOnkeydown(String onkeydown)
          Sets an onkeydown Javascript handler.
 void setOnkeypress(String onkeypress)
          Sets an onkeypress Javascript handler.
 void setOnkeyup(String onkeyup)
          Sets an onkeyup Javascript handler.
 void setOnmousedown(String onmousedown)
          Sets an onmousedown Javascript handler.
 void setOnmousemove(String onmousemove)
          Sets an onmousemove Javascript handler.
 void setOnmouseout(String onmouseout)
          Sets an onmouseout Javascript handler.
 void setOnmouseover(String onmouseover)
          Sets an onmouseover Javascript handler.
 void setOnmouseup(String onmouseup)
          Sets an onmouseup Javascript handler.
 void setPartialTriggers(String[] partialTriggers)
          Sets the IDs of the components that should trigger a partial update.
 void setSearch(javax.faces.component.UIComponent searchFacet)
          The search region of the page.
 void setShortDesc(String shortDesc)
          Sets The short description of the component.
 void setStyleClass(String styleClass)
          Sets a CSS style class to use for this component.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView
 
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 String CHROME_TYPE_COMPACT
See Also:
Constant Field Values

CHROME_TYPE_EXPANDED

public static final String CHROME_TYPE_EXPANDED
See Also:
Constant Field Values

TYPE

public static final FacesBean.Type TYPE

CHROME_TYPE_KEY

public static final PropertyKey CHROME_TYPE_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

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

NAVIGATION1_FACET

public static final String NAVIGATION1_FACET
See Also:
Constant Field Values

NAVIGATION2_FACET

public static final String NAVIGATION2_FACET
See Also:
Constant Field Values

NAVIGATION_GLOBAL_FACET

public static final String NAVIGATION_GLOBAL_FACET
See Also:
Constant Field Values

MENU_SWITCH_FACET

public static final String MENU_SWITCH_FACET
See Also:
Constant Field Values

BRANDING_FACET

public static final String BRANDING_FACET
See Also:
Constant Field Values

BRANDING_APP_FACET

public static final String BRANDING_APP_FACET
See Also:
Constant Field Values

BRANDING_APP_CONTEXTUAL_FACET

public static final String BRANDING_APP_CONTEXTUAL_FACET
See Also:
Constant Field Values

SEARCH_FACET

public static final String SEARCH_FACET
See Also:
Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values
Constructor Detail

CorePanelPageHeader

public CorePanelPageHeader()
Construct an instance of the CorePanelPageHeader.


CorePanelPageHeader

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

Method Detail

getNavigation1

public final javax.faces.component.UIComponent getNavigation1()
This location typically contains a menuTabs.


setNavigation1

public final void setNavigation1(javax.faces.component.UIComponent navigation1Facet)
This location typically contains a menuTabs.


getNavigation2

public final javax.faces.component.UIComponent getNavigation2()
This location typically contains a menuBar.


setNavigation2

public final void setNavigation2(javax.faces.component.UIComponent navigation2Facet)
This location typically contains a menuBar.


getNavigationGlobal

public final javax.faces.component.UIComponent getNavigationGlobal()
This section typically contains a menuButtons.


setNavigationGlobal

public final void setNavigationGlobal(javax.faces.component.UIComponent navigationGlobalFacet)
This section typically contains a menuButtons.


getMenuSwitch

public final javax.faces.component.UIComponent getMenuSwitch()
This location typically contains a menuChoice.


setMenuSwitch

public final void setMenuSwitch(javax.faces.component.UIComponent menuSwitchFacet)
This location typically contains a menuChoice.


getBranding

public final javax.faces.component.UIComponent getBranding()
The corporate or organization branding region of the page. This section typically contains a medium size image of the logo of the organization owning the page.


setBranding

public final void setBranding(javax.faces.component.UIComponent brandingFacet)
The corporate or organization branding region of the page. This section typically contains a medium size image of the logo of the organization owning the page.


getBrandingApp

public final javax.faces.component.UIComponent getBrandingApp()
The application, module, or product branding region of the page. This section typically contains a image of the application logo.


setBrandingApp

public final void setBrandingApp(javax.faces.component.UIComponent brandingAppFacet)
The application, module, or product branding region of the page. This section typically contains a image of the application logo.


getBrandingAppContextual

public final javax.faces.component.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.


setBrandingAppContextual

public final void setBrandingAppContextual(javax.faces.component.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.


getSearch

public final javax.faces.component.UIComponent getSearch()
The search region of the page.


setSearch

public final void setSearch(javax.faces.component.UIComponent searchFacet)
The search region of the page.


getChromeType

public final 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.

Returns:
the new chromeType value

setChromeType

public final void setChromeType(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.

Parameters:
chromeType - the new chromeType value

getInlineStyle

public final String getInlineStyle()
Gets the CSS styles to use for this component.

Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(String inlineStyle)
Sets the CSS styles to use for this component.

Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final String getStyleClass()
Gets a CSS style class to use for this component.

Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(String styleClass)
Sets a CSS style class to use for this component.

Parameters:
styleClass - the new styleClass value

getShortDesc

public final String getShortDesc()
Gets The short description of the component. This text is commonly used by user agents to display tooltip help text.

Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(String shortDesc)
Sets The short description of the component. This text is commonly used by user agents to display tooltip help text.

Parameters:
shortDesc - the new shortDesc value

getPartialTriggers

public final 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.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(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.

Separate multiple triggers with a space. e.g., partialTriggers="cmp1 cmp2"

Identifiers must account for NamingContainers. You can use a single colon to start the search from the root, or use multiple colons to move up through the NamingContainer. For example, "::" will pop out of this component's naming container (it pops out of itself if it is a naming container), ":::" will pop out of two naming containers, etc. The search for the partialTrigger begins from there. e.g., partialTriggers=":::commandButton1" the search begins for the component with id = commandButton1 after popping out of two naming containers relative to this component. To go into naming containers, you separate the naming containers with ':', e.g.,partialTriggers= "nc1:nc2:nc3:componentId".

Parameters:
partialTriggers - the new partialTriggers value

getOnclick

public final String getOnclick()
Gets an onclick Javascript handler.

Returns:
the new onclick value

setOnclick

public final void setOnclick(String onclick)
Sets an onclick Javascript handler.

Parameters:
onclick - the new onclick value

getOndblclick

public final String getOndblclick()
Gets an ondblclick Javascript handler.

Returns:
the new ondblclick value

setOndblclick

public final void setOndblclick(String ondblclick)
Sets an ondblclick Javascript handler.

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

public final String getOnmousedown()
Gets an onmousedown Javascript handler.

Returns:
the new onmousedown value

setOnmousedown

public final void setOnmousedown(String onmousedown)
Sets an onmousedown Javascript handler.

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

public final String getOnmouseup()
Gets an onmouseup Javascript handler.

Returns:
the new onmouseup value

setOnmouseup

public final void setOnmouseup(String onmouseup)
Sets an onmouseup Javascript handler.

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

public final String getOnmouseover()
Gets an onmouseover Javascript handler.

Returns:
the new onmouseover value

setOnmouseover

public final void setOnmouseover(String onmouseover)
Sets an onmouseover Javascript handler.

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

public final String getOnmousemove()
Gets an onmousemove Javascript handler.

Returns:
the new onmousemove value

setOnmousemove

public final void setOnmousemove(String onmousemove)
Sets an onmousemove Javascript handler.

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

public final String getOnmouseout()
Gets an onmouseout Javascript handler.

Returns:
the new onmouseout value

setOnmouseout

public final void setOnmouseout(String onmouseout)
Sets an onmouseout Javascript handler.

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

public final String getOnkeypress()
Gets an onkeypress Javascript handler.

Returns:
the new onkeypress value

setOnkeypress

public final void setOnkeypress(String onkeypress)
Sets an onkeypress Javascript handler.

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

public final String getOnkeydown()
Gets an onkeydown Javascript handler.

Returns:
the new onkeydown value

setOnkeydown

public final void setOnkeydown(String onkeydown)
Sets an onkeydown Javascript handler.

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

public final String getOnkeyup()
Gets an onkeyup Javascript handler.

Returns:
the new onkeyup value

setOnkeyup

public final void setOnkeyup(String onkeyup)
Sets an onkeyup Javascript handler.

Parameters:
onkeyup - the new onkeyup value

getDefaultEventName

public String getDefaultEventName()
Description copied from class: UIXComponentBase
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.

This method must only be called by classes that implement the interface, doing otherwise will result in an exception.

Specified by:
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getDefaultEventName in class UIXComponentBase
Returns:
null
See Also:
ClientBehaviorHolder.getDefaultEventName()

getEventNames

public Collection<String> getEventNames()
Specified by:
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
Description copied from class: UIXComponentBase
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.

This method must only be called by classes that implement the interface, doing otherwise will result in an exception.

Specified by:
getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
getClientBehaviors in class UIXComponentBase
Returns:
Read-only map of the client behaviors for this component
See Also:
ClientBehaviorHolder.getClientBehaviors()

addClientBehavior

public void addClientBehavior(String eventName,
                              javax.faces.component.behavior.ClientBehavior behavior)
Description copied from class: UIXComponentBase
Utility method to assist sub-classes in the implementation of the ClientBehaviorHolder interface.

This method must only be called by classes that implement the interface, doing otherwise will result in an exception.

Specified by:
addClientBehavior in interface javax.faces.component.behavior.ClientBehaviorHolder
Overrides:
addClientBehavior in class UIXComponentBase
Parameters:
eventName - The event name
behavior - The behavior to add
See Also:
ClientBehaviorHolder.addClientBehavior(String, ClientBehavior)

getFamily

public String getFamily()
Overrides:
getFamily in class UIXPanel

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXPanel


Copyright © 2001-2012 The Apache Software Foundation. All Rights Reserved.