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

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.CorePanelBorderLayout
All Implemented Interfaces:
javax.faces.component.StateHolder

public class CorePanelBorderLayout
extends UIXPanel

The panelBorderLayout component is a layout element which lays out all of its children consecutively in its middle, and supports twelve other facets: top, bottom, left, right, start and end. Clients should use only one of left/right or start/end for each side, in any one container, but if both are used, left/right "wins".

Events:

Type Phases Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent Apply Request Values Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.


Field Summary
static java.lang.String BOTTOM_FACET
           
static java.lang.String COMPONENT_FAMILY
           
static java.lang.String COMPONENT_TYPE
           
static java.lang.String END_FACET
           
static PropertyKey INLINE_STYLE_KEY
           
static java.lang.String INNER_BOTTOM_FACET
           
static java.lang.String INNER_END_FACET
           
static java.lang.String INNER_LEFT_FACET
           
static java.lang.String INNER_RIGHT_FACET
           
static java.lang.String INNER_START_FACET
           
static java.lang.String INNER_TOP_FACET
           
static java.lang.String LEFT_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 RIGHT_FACET
           
static PropertyKey SHORT_DESC_KEY
           
static java.lang.String START_FACET
           
static PropertyKey STYLE_CLASS_KEY
           
static java.lang.String TOP_FACET
           
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
bindings
 
Constructor Summary
  CorePanelBorderLayout()
          Construct an instance of the CorePanelBorderLayout.
protected CorePanelBorderLayout(java.lang.String rendererType)
          Construct an instance of the CorePanelBorderLayout.
 
Method Summary
protected  FacesBean.Type getBeanType()
           
 javax.faces.component.UIComponent getBottom()
          Content to be rendered below the children.
 javax.faces.component.UIComponent getEnd()
          Content to be rendered to the right of the children and between any top and bottom facets, if the reading direction is left-to-right, on the left otherwise.
 java.lang.String getFamily()
           
 java.lang.String getInlineStyle()
          Gets the CSS styles to use for this component.
 javax.faces.component.UIComponent getInnerBottom()
          Content to be rendered below the children, but above 'bottom'.
 javax.faces.component.UIComponent getInnerEnd()
          the equivalent of innerRight on left-to-right clients and innerLeft on right-to-left clients.
 javax.faces.component.UIComponent getInnerLeft()
          Content to be rendered to the left of the children and between any innerTop and innerBottom facets, to the right of the left facet.
 javax.faces.component.UIComponent getInnerRight()
          Content to be rendered to the right of the children and between any innerTop and innerBottom facets.
 javax.faces.component.UIComponent getInnerStart()
          the equivalent of innerLeft on left-to-right clients and innerRight on right-to-left clients.
 javax.faces.component.UIComponent getInnerTop()
          Content to be rendered above the children, inside of 'top'.
 javax.faces.component.UIComponent getLeft()
          Content to be rendered to the left of the children and between any top and bottom facets.
 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.
 javax.faces.component.UIComponent getRight()
          Content to be rendered to the right of the children and between any top and bottom facets.
 java.lang.String getShortDesc()
          Gets The short description of the component.
 javax.faces.component.UIComponent getStart()
          Content to be rendered to the left of the children and between any top and bottom facets, if the reading direction is left-to-right, on the right otherwise.
 java.lang.String getStyleClass()
          Gets a CSS style class to use for this component.
 javax.faces.component.UIComponent getTop()
          Content to be rendered above the children.
 void setBottom(javax.faces.component.UIComponent bottomFacet)
          Content to be rendered below the children.
 void setEnd(javax.faces.component.UIComponent endFacet)
          Content to be rendered to the right of the children and between any top and bottom facets, if the reading direction is left-to-right, on the left otherwise.
 void setInlineStyle(java.lang.String inlineStyle)
          Sets the CSS styles to use for this component.
 void setInnerBottom(javax.faces.component.UIComponent innerBottomFacet)
          Content to be rendered below the children, but above 'bottom'.
 void setInnerEnd(javax.faces.component.UIComponent innerEndFacet)
          the equivalent of innerRight on left-to-right clients and innerLeft on right-to-left clients.
 void setInnerLeft(javax.faces.component.UIComponent innerLeftFacet)
          Content to be rendered to the left of the children and between any innerTop and innerBottom facets, to the right of the left facet.
 void setInnerRight(javax.faces.component.UIComponent innerRightFacet)
          Content to be rendered to the right of the children and between any innerTop and innerBottom facets.
 void setInnerStart(javax.faces.component.UIComponent innerStartFacet)
          the equivalent of innerLeft on left-to-right clients and innerRight on right-to-left clients.
 void setInnerTop(javax.faces.component.UIComponent innerTopFacet)
          Content to be rendered above the children, inside of 'top'.
 void setLeft(javax.faces.component.UIComponent leftFacet)
          Content to be rendered to the left of the children and between any top and bottom facets.
 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 setRight(javax.faces.component.UIComponent rightFacet)
          Content to be rendered to the right of the children and between any top and bottom facets.
 void setShortDesc(java.lang.String shortDesc)
          Sets The short description of the component.
 void setStart(javax.faces.component.UIComponent startFacet)
          Content to be rendered to the left of the children and between any top and bottom facets, if the reading direction is left-to-right, on the right otherwise.
 void setStyleClass(java.lang.String styleClass)
          Sets a CSS style class to use for this component.
 void setTop(javax.faces.component.UIComponent topFacet)
          Content to be rendered above the children.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, 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, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl
 
Methods inherited from class javax.faces.component.UIComponent
getContainerClientId, invokeOnComponent
 
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

TOP_FACET

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

BOTTOM_FACET

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

LEFT_FACET

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

RIGHT_FACET

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

START_FACET

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

END_FACET

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

INNER_TOP_FACET

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

INNER_BOTTOM_FACET

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

INNER_LEFT_FACET

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

INNER_RIGHT_FACET

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

INNER_START_FACET

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

INNER_END_FACET

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

CorePanelBorderLayout

public CorePanelBorderLayout()
Construct an instance of the CorePanelBorderLayout.


CorePanelBorderLayout

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

Method Detail

getTop

public final javax.faces.component.UIComponent getTop()
Content to be rendered above the children.


setTop

public final void setTop(javax.faces.component.UIComponent topFacet)
Content to be rendered above the children.


getBottom

public final javax.faces.component.UIComponent getBottom()
Content to be rendered below the children.


setBottom

public final void setBottom(javax.faces.component.UIComponent bottomFacet)
Content to be rendered below the children.


getLeft

public final javax.faces.component.UIComponent getLeft()
Content to be rendered to the left of the children and between any top and bottom facets.


setLeft

public final void setLeft(javax.faces.component.UIComponent leftFacet)
Content to be rendered to the left of the children and between any top and bottom facets.


getRight

public final javax.faces.component.UIComponent getRight()
Content to be rendered to the right of the children and between any top and bottom facets.


setRight

public final void setRight(javax.faces.component.UIComponent rightFacet)
Content to be rendered to the right of the children and between any top and bottom facets.


getStart

public final javax.faces.component.UIComponent getStart()
Content to be rendered to the left of the children and between any top and bottom facets, if the reading direction is left-to-right, on the right otherwise.


setStart

public final void setStart(javax.faces.component.UIComponent startFacet)
Content to be rendered to the left of the children and between any top and bottom facets, if the reading direction is left-to-right, on the right otherwise.


getEnd

public final javax.faces.component.UIComponent getEnd()
Content to be rendered to the right of the children and between any top and bottom facets, if the reading direction is left-to-right, on the left otherwise.


setEnd

public final void setEnd(javax.faces.component.UIComponent endFacet)
Content to be rendered to the right of the children and between any top and bottom facets, if the reading direction is left-to-right, on the left otherwise.


getInnerTop

public final javax.faces.component.UIComponent getInnerTop()
Content to be rendered above the children, inside of 'top'.


setInnerTop

public final void setInnerTop(javax.faces.component.UIComponent innerTopFacet)
Content to be rendered above the children, inside of 'top'.


getInnerBottom

public final javax.faces.component.UIComponent getInnerBottom()
Content to be rendered below the children, but above 'bottom'.


setInnerBottom

public final void setInnerBottom(javax.faces.component.UIComponent innerBottomFacet)
Content to be rendered below the children, but above 'bottom'.


getInnerLeft

public final javax.faces.component.UIComponent getInnerLeft()
Content to be rendered to the left of the children and between any innerTop and innerBottom facets, to the right of the left facet.


setInnerLeft

public final void setInnerLeft(javax.faces.component.UIComponent innerLeftFacet)
Content to be rendered to the left of the children and between any innerTop and innerBottom facets, to the right of the left facet.


getInnerRight

public final javax.faces.component.UIComponent getInnerRight()
Content to be rendered to the right of the children and between any innerTop and innerBottom facets.


setInnerRight

public final void setInnerRight(javax.faces.component.UIComponent innerRightFacet)
Content to be rendered to the right of the children and between any innerTop and innerBottom facets.


getInnerStart

public final javax.faces.component.UIComponent getInnerStart()
the equivalent of innerLeft on left-to-right clients and innerRight on right-to-left clients.


setInnerStart

public final void setInnerStart(javax.faces.component.UIComponent innerStartFacet)
the equivalent of innerLeft on left-to-right clients and innerRight on right-to-left clients.


getInnerEnd

public final javax.faces.component.UIComponent getInnerEnd()
the equivalent of innerRight on left-to-right clients and innerLeft on right-to-left clients.


setInnerEnd

public final void setInnerEnd(javax.faces.component.UIComponent innerEndFacet)
the equivalent of innerRight on left-to-right clients and innerLeft on right-to-left clients.


getInlineStyle

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

Returns:
the new inlineStyle value

setInlineStyle

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

Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

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

Returns:
the new styleClass value

setStyleClass

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

Parameters:
styleClass - the new styleClass value

getShortDesc

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

Returns:
the new shortDesc value

setShortDesc

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

Parameters:
shortDesc - the new shortDesc value

getPartialTriggers

public final java.lang.String[] getPartialTriggers()
Gets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component, and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, etc.

Returns:
the new partialTriggers value

setPartialTriggers

public final void setPartialTriggers(java.lang.String[] partialTriggers)
Sets the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component, and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root, or multiple colons to move up through the NamingContainers - "::" will search from the parent naming container, ":::" will search from the grandparent naming container, etc.

Parameters:
partialTriggers - the new partialTriggers value

getOnclick

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

Returns:
the new onclick value

setOnclick

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

Parameters:
onclick - the new onclick value

getOndblclick

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

Returns:
the new ondblclick value

setOndblclick

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

Parameters:
ondblclick - the new ondblclick value

getOnmousedown

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

Returns:
the new onmousedown value

setOnmousedown

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

Parameters:
onmousedown - the new onmousedown value

getOnmouseup

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

Returns:
the new onmouseup value

setOnmouseup

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

Parameters:
onmouseup - the new onmouseup value

getOnmouseover

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

Returns:
the new onmouseover value

setOnmouseover

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

Parameters:
onmouseover - the new onmouseover value

getOnmousemove

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

Returns:
the new onmousemove value

setOnmousemove

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

Parameters:
onmousemove - the new onmousemove value

getOnmouseout

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

Returns:
the new onmouseout value

setOnmouseout

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

Parameters:
onmouseout - the new onmouseout value

getOnkeypress

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

Returns:
the new onkeypress value

setOnkeypress

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

Parameters:
onkeypress - the new onkeypress value

getOnkeydown

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

Returns:
the new onkeydown value

setOnkeydown

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

Parameters:
onkeydown - the new onkeydown value

getOnkeyup

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

Returns:
the new onkeyup value

setOnkeyup

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

Parameters:
onkeyup - the new onkeyup value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class UIXPanel

getBeanType

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


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.