public class RichPanelBorderLayout
extends org.apache.myfaces.trinidad.component.UIXPanel
implements javax.faces.component.behavior.ClientBehaviorHolder
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. |
Modifier and Type | Field and Description |
---|---|
static String |
BOTTOM_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_ATTRIBUTES_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_COMPONENT_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CLIENT_LISTENERS_KEY |
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY
Deprecated.
|
static String |
END_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static String |
INNER_BOTTOM_FACET |
static String |
INNER_END_FACET |
static String |
INNER_LEFT_FACET |
static String |
INNER_RIGHT_FACET |
static String |
INNER_START_FACET |
static String |
INNER_TOP_FACET |
static String |
LEFT_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static String |
RIGHT_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static String |
START_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static String |
TOP_FACET |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VISIBLE_KEY |
Modifier | Constructor and Description |
---|---|
|
RichPanelBorderLayout()
Construct an instance of the RichPanelBorderLayout.
|
protected |
RichPanelBorderLayout(String rendererType)
Construct an instance of the RichPanelBorderLayout.
|
Modifier and Type | Method and Description |
---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
javax.faces.component.UIComponent |
getBottom()
Content to be rendered below the children.
|
Set |
getClientAttributes()
Gets a set of client attribute names.
|
Map<String,List<javax.faces.component.behavior.ClientBehavior>> |
getClientBehaviors() |
ClientListenerSet |
getClientListeners()
Gets a set of client listeners.
|
String |
getCustomizationId()
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
String |
getDefaultEventName() |
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.
|
Collection<String> |
getEventNames() |
String |
getFamily() |
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.
|
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.
|
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.
|
String |
getStyleClass()
Gets a CSS style class to use for this component.
|
javax.faces.component.UIComponent |
getTop()
Content to be rendered above the children.
|
Set<String> |
getUnsecure()
Gets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
|
boolean |
isClientComponent()
Gets whether a client-side component will be generated.
|
boolean |
isVisible()
Gets the visibility of the component.
|
void |
setBottom(javax.faces.component.UIComponent bottomFacet)
Content to be rendered below the children.
|
void |
setClientAttributes(Set clientAttributes)
Sets a set of client attribute names.
|
void |
setClientComponent(boolean clientComponent)
Sets whether a client-side component will be generated.
|
void |
setClientListeners(ClientListenerSet clientListeners)
Sets a set of client listeners.
|
void |
setCustomizationId(String customizationId)
Deprecated.
This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead.
|
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(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 |
setPartialTriggers(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(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(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.
|
void |
setUnsecure(Set<String> unsecure)
Sets A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client.
|
void |
setVisible(boolean visible)
Sets the visibility of the component.
|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, 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, removeComponentChangeFilter, 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
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, 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
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey UNSECURE_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VISIBLE_KEY
@Deprecated public static final org.apache.myfaces.trinidad.bean.PropertyKey CUSTOMIZATION_ID_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_COMPONENT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_ATTRIBUTES_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey PARTIAL_TRIGGERS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey CLIENT_LISTENERS_KEY
public static final String TOP_FACET
public static final String BOTTOM_FACET
public static final String LEFT_FACET
public static final String RIGHT_FACET
public static final String START_FACET
public static final String END_FACET
public static final String INNER_TOP_FACET
public static final String INNER_BOTTOM_FACET
public static final String INNER_LEFT_FACET
public static final String INNER_RIGHT_FACET
public static final String INNER_START_FACET
public static final String INNER_END_FACET
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
public RichPanelBorderLayout()
protected RichPanelBorderLayout(String rendererType)
public final javax.faces.component.UIComponent getTop()
public final void setTop(javax.faces.component.UIComponent topFacet)
public final javax.faces.component.UIComponent getBottom()
public final void setBottom(javax.faces.component.UIComponent bottomFacet)
public final javax.faces.component.UIComponent getLeft()
public final void setLeft(javax.faces.component.UIComponent leftFacet)
public final javax.faces.component.UIComponent getRight()
public final void setRight(javax.faces.component.UIComponent rightFacet)
public final javax.faces.component.UIComponent getStart()
public final void setStart(javax.faces.component.UIComponent startFacet)
public final javax.faces.component.UIComponent getEnd()
public final void setEnd(javax.faces.component.UIComponent endFacet)
public final javax.faces.component.UIComponent getInnerTop()
public final void setInnerTop(javax.faces.component.UIComponent innerTopFacet)
public final javax.faces.component.UIComponent getInnerBottom()
public final void setInnerBottom(javax.faces.component.UIComponent innerBottomFacet)
public final javax.faces.component.UIComponent getInnerLeft()
public final void setInnerLeft(javax.faces.component.UIComponent innerLeftFacet)
public final javax.faces.component.UIComponent getInnerRight()
public final void setInnerRight(javax.faces.component.UIComponent innerRightFacet)
public final javax.faces.component.UIComponent getInnerStart()
public final void setInnerStart(javax.faces.component.UIComponent innerStartFacet)
public final javax.faces.component.UIComponent getInnerEnd()
public final void setInnerEnd(javax.faces.component.UIComponent innerEndFacet)
public final String getInlineStyle()
public final void setInlineStyle(String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final String getStyleClass()
public final void setStyleClass(String styleClass)
styleClass
- the new styleClass valuepublic final String getShortDesc()
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
public final void setShortDesc(String shortDesc)
For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute.
shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
shortDesc
- the new shortDesc valuepublic final Set<String> getUnsecure()
public final void setUnsecure(Set<String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value@Deprecated public final String getCustomizationId()
@Deprecated public final void setCustomizationId(String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final Set getClientAttributes()
public final void setClientAttributes(Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final String[] getPartialTriggers()
public final void setPartialTriggers(String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic String getDefaultEventName()
getDefaultEventName
in interface javax.faces.component.behavior.ClientBehaviorHolder
getDefaultEventName
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public Collection<String> getEventNames()
getEventNames
in interface javax.faces.component.behavior.ClientBehaviorHolder
public Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors
in interface javax.faces.component.behavior.ClientBehaviorHolder
getClientBehaviors
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior)
addClientBehavior
in interface javax.faces.component.behavior.ClientBehaviorHolder
addClientBehavior
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXPanel
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXPanel