|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXPanel
oracle.adf.view.rich.component.rich.layout.RichPanelBorderLayout
public class RichPanelBorderLayout
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". Left, InnerLeft/Right InnerRight always means left/right regardless of LTR or RTL. Start, InnerStart/End, InnerEnd will respect bidi setting. <section name="Geometry_Management"> <html:ul> <html:li>This component cannot be stretched by a parent layout component that stretches its children, e.g., panelStretchLayout.</html:li> <html:li>This component does not stretch its children.</html:li> </html:ul> </section>
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 events might include the width of a column that supported client-side resizing. |
Field Summary | |
---|---|
static java.lang.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 java.lang.String |
COMPONENT_FAMILY |
static java.lang.String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEY Deprecated. |
static java.lang.String |
END_FACET |
static org.apache.myfaces.trinidad.bean.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 org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static java.lang.String |
RIGHT_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static java.lang.String |
START_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static java.lang.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 |
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 | |
---|---|
|
RichPanelBorderLayout() Construct an instance of the RichPanelBorderLayout. |
protected |
RichPanelBorderLayout(java.lang.String rendererType) Construct an instance of the RichPanelBorderLayout. |
Method Summary | |
---|---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
javax.faces.component.UIComponent |
getBottom() Content to be rendered below the children. |
java.util.Set |
getClientAttributes() Gets a set of client attribute names. |
ClientListenerSet |
getClientListeners() Gets a set of client listeners. |
java.lang.String |
getCustomizationId() Deprecated. This attribute is deprecated. This attribute will be removed in the next release. Use the 'id' attribute instead. |
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[] |
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. |
java.util.Set<java.lang.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(java.util.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(java.lang.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(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 |
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. |
void |
setUnsecure(java.util.Set<java.lang.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. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, 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, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, 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, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
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 java.lang.String TOP_FACET
public static final java.lang.String BOTTOM_FACET
public static final java.lang.String LEFT_FACET
public static final java.lang.String RIGHT_FACET
public static final java.lang.String START_FACET
public static final java.lang.String END_FACET
public static final java.lang.String INNER_TOP_FACET
public static final java.lang.String INNER_BOTTOM_FACET
public static final java.lang.String INNER_LEFT_FACET
public static final java.lang.String INNER_RIGHT_FACET
public static final java.lang.String INNER_START_FACET
public static final java.lang.String INNER_END_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichPanelBorderLayout()
protected RichPanelBorderLayout(java.lang.String rendererType)
Method Detail |
---|
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 java.lang.String getInlineStyle()
public final void setInlineStyle(java.lang.String inlineStyle)
inlineStyle
- the new inlineStyle valuepublic final java.lang.String getStyleClass()
public final void setStyleClass(java.lang.String styleClass)
styleClass
- the new styleClass valuepublic final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.util.Set<java.lang.String> getUnsecure()
public final void setUnsecure(java.util.Set<java.lang.String> unsecure)
unsecure
- the new unsecure valuepublic final boolean isVisible()
public final void setVisible(boolean visible)
visible
- the new visible value
@Deprecated
public final java.lang.String getCustomizationId()
@Deprecated
public final void setCustomizationId(java.lang.String customizationId)
customizationId
- the new customizationId valuepublic final boolean isClientComponent()
public final void setClientComponent(boolean clientComponent)
clientComponent
- the new clientComponent valuepublic final java.util.Set getClientAttributes()
public final void setClientAttributes(java.util.Set clientAttributes)
clientAttributes
- the new clientAttributes valuepublic final java.lang.String[] getPartialTriggers()
public final void setPartialTriggers(java.lang.String[] partialTriggers)
partialTriggers
- the new partialTriggers valuepublic final ClientListenerSet getClientListeners()
public final void setClientListeners(ClientListenerSet clientListeners)
clientListeners
- the new clientListeners valuepublic java.lang.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
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-06 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |