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

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.CorePanelPage
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 CorePanelPage
extends UIXPanel
implements javax.faces.component.behavior.ClientBehaviorHolder

PanelPage lays out an entire page. It supports several navigation and content areas for the creation of pages. When the panelPage is geometry managed, the last indexed child will be stretched vertically to fit in the leftover space not consumed by the other indexed children. If you do not want this stretching behavior, you must wrap your indexed children with a panelGroup with layout="vertical" and inlineStyle="overflow: auto;". This way, the panelGroup will be stretched to fit and scrollbars will appear when the content inside is larger than the allocated space.

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 APP_ABOUT_FACET
           
static String APP_COPYRIGHT_FACET
           
static String APP_PRIVACY_FACET
           
static PropertyKey AUXILIARY_GLOBAL_SIZE_KEY
           
static PropertyKey AUXILIARY1SIZE_KEY
           
static PropertyKey AUXILIARY2SIZE_KEY
           
static String BRANDING_FACET
           
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static String INFO_FOOTNOTE_FACET
           
static String INFO_RETURN_FACET
           
static String INFO_STATUS_FACET
           
static String INFO_USER_FACET
           
static PropertyKey INLINE_STYLE_KEY
           
static String LOCATION_FACET
           
static String NAVIGATION_GLOBAL_FACET
           
static String NAVIGATION1_FACET
           
static String NAVIGATION2_FACET
           
static String NAVIGATION3_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
  CorePanelPage()
          Construct an instance of the CorePanelPage.
protected CorePanelPage(String rendererType)
          Construct an instance of the CorePanelPage.
 
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.
 javax.faces.component.UIComponent getAppAbout()
          Area to put a commandLink to more information about the application.
 javax.faces.component.UIComponent getAppCopyright()
          The copyright region of the page.
 javax.faces.component.UIComponent getAppPrivacy()
          The privacy region of the page.
 int getAuxiliary1Size()
          Gets Specifies the number of pixels that the auxiliary1 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
 int getAuxiliary2Size()
          Gets Specifies the number of pixels that the auxiliary2 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
 int getAuxiliaryGlobalSize()
          Gets Specifies the number of pixels that the auxiliaryGlobal content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
protected  FacesBean.Type getBeanType()
           
 javax.faces.component.UIComponent getBranding()
          The branding region of the page.
 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()
           
 javax.faces.component.UIComponent getInfoFootnote()
          The footnote information region.
 javax.faces.component.UIComponent getInfoReturn()
          The return information region.
 javax.faces.component.UIComponent getInfoStatus()
          The status information region.
 javax.faces.component.UIComponent getInfoUser()
          The user information region.
 String getInlineStyle()
          Gets the CSS styles to use for this component.
 javax.faces.component.UIComponent getLocation()
          The locator region of the page.
 javax.faces.component.UIComponent getNavigation1()
          This location typically contains tabs for the primary layer.
 javax.faces.component.UIComponent getNavigation2()
          This location typically contains tabs for the secondary layer.
 javax.faces.component.UIComponent getNavigation3()
          An optional vertically oriented region of contexual components for the main content.
 javax.faces.component.UIComponent getNavigationGlobal()
          This section typically contains global application links or otherwise top level navigation structure links, e.g.
 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 setAppAbout(javax.faces.component.UIComponent appAboutFacet)
          Area to put a commandLink to more information about the application.
 void setAppCopyright(javax.faces.component.UIComponent appCopyrightFacet)
          The copyright region of the page.
 void setAppPrivacy(javax.faces.component.UIComponent appPrivacyFacet)
          The privacy region of the page.
 void setAuxiliary1Size(int auxiliary1Size)
          Sets Specifies the number of pixels that the auxiliary1 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
 void setAuxiliary2Size(int auxiliary2Size)
          Sets Specifies the number of pixels that the auxiliary2 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
 void setAuxiliaryGlobalSize(int auxiliaryGlobalSize)
          Sets Specifies the number of pixels that the auxiliaryGlobal content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").
 void setBranding(javax.faces.component.UIComponent brandingFacet)
          The branding region of the page.
 void setInfoFootnote(javax.faces.component.UIComponent infoFootnoteFacet)
          The footnote information region.
 void setInfoReturn(javax.faces.component.UIComponent infoReturnFacet)
          The return information region.
 void setInfoStatus(javax.faces.component.UIComponent infoStatusFacet)
          The status information region.
 void setInfoUser(javax.faces.component.UIComponent infoUserFacet)
          The user information region.
 void setInlineStyle(String inlineStyle)
          Sets the CSS styles to use for this component.
 void setLocation(javax.faces.component.UIComponent locationFacet)
          The locator region of the page.
 void setNavigation1(javax.faces.component.UIComponent navigation1Facet)
          This location typically contains tabs for the primary layer.
 void setNavigation2(javax.faces.component.UIComponent navigation2Facet)
          This location typically contains tabs for the secondary layer.
 void setNavigation3(javax.faces.component.UIComponent navigation3Facet)
          An optional vertically oriented region of contexual components for the main content.
 void setNavigationGlobal(javax.faces.component.UIComponent navigationGlobalFacet)
          This section typically contains global application links or otherwise top level navigation structure links, e.g.
 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

TYPE

public static final FacesBean.Type TYPE

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

AUXILIARY1SIZE_KEY

public static final PropertyKey AUXILIARY1SIZE_KEY

AUXILIARY2SIZE_KEY

public static final PropertyKey AUXILIARY2SIZE_KEY

AUXILIARY_GLOBAL_SIZE_KEY

public static final PropertyKey AUXILIARY_GLOBAL_SIZE_KEY

APP_ABOUT_FACET

public static final String APP_ABOUT_FACET
See Also:
Constant Field Values

APP_COPYRIGHT_FACET

public static final String APP_COPYRIGHT_FACET
See Also:
Constant Field Values

APP_PRIVACY_FACET

public static final String APP_PRIVACY_FACET
See Also:
Constant Field Values

BRANDING_FACET

public static final String BRANDING_FACET
See Also:
Constant Field Values

INFO_FOOTNOTE_FACET

public static final String INFO_FOOTNOTE_FACET
See Also:
Constant Field Values

INFO_RETURN_FACET

public static final String INFO_RETURN_FACET
See Also:
Constant Field Values

INFO_STATUS_FACET

public static final String INFO_STATUS_FACET
See Also:
Constant Field Values

INFO_USER_FACET

public static final String INFO_USER_FACET
See Also:
Constant Field Values

LOCATION_FACET

public static final String LOCATION_FACET
See Also:
Constant Field Values

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

NAVIGATION3_FACET

public static final String NAVIGATION3_FACET
See Also:
Constant Field Values

NAVIGATION_GLOBAL_FACET

public static final String NAVIGATION_GLOBAL_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

CorePanelPage

public CorePanelPage()
Construct an instance of the CorePanelPage.


CorePanelPage

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

Method Detail

getAppAbout

public final javax.faces.component.UIComponent getAppAbout()
Area to put a commandLink to more information about the application.


setAppAbout

public final void setAppAbout(javax.faces.component.UIComponent appAboutFacet)
Area to put a commandLink to more information about the application.


getAppCopyright

public final javax.faces.component.UIComponent getAppCopyright()
The copyright region of the page. If present, this area typically contains an outputText with the copyright information.


setAppCopyright

public final void setAppCopyright(javax.faces.component.UIComponent appCopyrightFacet)
The copyright region of the page. If present, this area typically contains an outputText with the copyright information.


getAppPrivacy

public final javax.faces.component.UIComponent getAppPrivacy()
The privacy region of the page. If present, this area typically contains a commandLink to the privacy policy for the application.


setAppPrivacy

public final void setAppPrivacy(javax.faces.component.UIComponent appPrivacyFacet)
The privacy region of the page. If present, this area typically contains a commandLink to the privacy policy for the application.


getBranding

public final javax.faces.component.UIComponent getBranding()
The branding region of the page. This section typically contains a horizontal panelGroup for an image of a logo and an outputText for a title.


setBranding

public final void setBranding(javax.faces.component.UIComponent brandingFacet)
The branding region of the page. This section typically contains a horizontal panelGroup for an image of a logo and an outputText for a title.


getInfoFootnote

public final javax.faces.component.UIComponent getInfoFootnote()
The footnote information region. This region provides a location for page-level information that is ancillary to the user's task.


setInfoFootnote

public final void setInfoFootnote(javax.faces.component.UIComponent infoFootnoteFacet)
The footnote information region. This region provides a location for page-level information that is ancillary to the user's task.


getInfoReturn

public final javax.faces.component.UIComponent getInfoReturn()
The return information region. Typically this will contain a "return to [X]" link.


setInfoReturn

public final void setInfoReturn(javax.faces.component.UIComponent infoReturnFacet)
The return information region. Typically this will contain a "return to [X]" link.


getInfoStatus

public final javax.faces.component.UIComponent getInfoStatus()
The status information region. This region provides a location for page-level status that is important to the user's task.


setInfoStatus

public final void setInfoStatus(javax.faces.component.UIComponent infoStatusFacet)
The status information region. This region provides a location for page-level status that is important to the user's task.


getInfoUser

public final javax.faces.component.UIComponent getInfoUser()
The user information region. This region provides a location for presenting user sign-in and connection information.


setInfoUser

public final void setInfoUser(javax.faces.component.UIComponent infoUserFacet)
The user information region. This region provides a location for presenting user sign-in and connection information.


getLocation

public final javax.faces.component.UIComponent getLocation()
The locator region of the page. If present, this section typically contains either a processTrain, indicating the user's location in a multistep process, or navigationPath, containing links that will bring the user back to each of the parent pages of a tree of pages that he has navigated down into.


setLocation

public final void setLocation(javax.faces.component.UIComponent locationFacet)
The locator region of the page. If present, this section typically contains either a processTrain, indicating the user's location in a multistep process, or navigationPath, containing links that will bring the user back to each of the parent pages of a tree of pages that he has navigated down into.


getNavigation1

public final javax.faces.component.UIComponent getNavigation1()
This location typically contains tabs for the primary layer.


setNavigation1

public final void setNavigation1(javax.faces.component.UIComponent navigation1Facet)
This location typically contains tabs for the primary layer.


getNavigation2

public final javax.faces.component.UIComponent getNavigation2()
This location typically contains tabs for the secondary layer.


setNavigation2

public final void setNavigation2(javax.faces.component.UIComponent navigation2Facet)
This location typically contains tabs for the secondary layer.


getNavigation3

public final javax.faces.component.UIComponent getNavigation3()
An optional vertically oriented region of contexual components for the main content. Often this contains a list or tree of links for deeper navigation structure than the global, primary, and secondary regions can provide.


setNavigation3

public final void setNavigation3(javax.faces.component.UIComponent navigation3Facet)
An optional vertically oriented region of contexual components for the main content. Often this contains a list or tree of links for deeper navigation structure than the global, primary, and secondary regions can provide.


getNavigationGlobal

public final javax.faces.component.UIComponent getNavigationGlobal()
This section typically contains global application links or otherwise top level navigation structure links, e.g. "Home", "Preferences", "Help", and "Sign Out".


setNavigationGlobal

public final void setNavigationGlobal(javax.faces.component.UIComponent navigationGlobalFacet)
This section typically contains global application links or otherwise top level navigation structure links, e.g. "Home", "Preferences", "Help", and "Sign Out".


getSearch

public final javax.faces.component.UIComponent getSearch()
The search region of the page. Typically used for application or system-wide searches.


setSearch

public final void setSearch(javax.faces.component.UIComponent searchFacet)
The search region of the page. Typically used for application or system-wide searches.


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

getAuxiliary1Size

public final int getAuxiliary1Size()
Gets Specifies the number of pixels that the auxiliary1 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").

Returns:
the new auxiliary1Size value

setAuxiliary1Size

public final void setAuxiliary1Size(int auxiliary1Size)
Sets Specifies the number of pixels that the auxiliary1 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").

Parameters:
auxiliary1Size - the new auxiliary1Size value

getAuxiliary2Size

public final int getAuxiliary2Size()
Gets Specifies the number of pixels that the auxiliary2 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").

Returns:
the new auxiliary2Size value

setAuxiliary2Size

public final void setAuxiliary2Size(int auxiliary2Size)
Sets Specifies the number of pixels that the auxiliary2 content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").

Parameters:
auxiliary2Size - the new auxiliary2Size value

getAuxiliaryGlobalSize

public final int getAuxiliaryGlobalSize()
Gets Specifies the number of pixels that the auxiliaryGlobal content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").

Returns:
the new auxiliaryGlobalSize value

setAuxiliaryGlobalSize

public final void setAuxiliaryGlobalSize(int auxiliaryGlobalSize)
Sets Specifies the number of pixels that the auxiliaryGlobal content should consume (this is a width if the orientationis "start" or "end" or a height if the orientation is "bottom").

Parameters:
auxiliaryGlobalSize - the new auxiliaryGlobalSize 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.