|
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1.7.0) E10684-08 |
|||||||||
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.RichPanelGroupLayout
public class RichPanelGroupLayout
The panelGroupLayout control is a layout element that arranges its children in one of a few simple patterns. Each pair of adjacent children will be separated by an optional separator child. It can lay out children consecutively (wrapping as needed), or in a single horizontal line, or vertically. <p/> Note about stretching layouts and flowing/scrolling layouts: <p/> With today's web browsers, it is not reliable to have vertically-stretched content inside of areas that also have scroll bars. If you want the outer areas of your page structure to stretch, you need to be careful of how you assemble your component tree.
Rules of thumb:
If you believe that you need to break one of these rules, this is an indication that your page structure is not following the page structure guidelines and you will likely have troubles getting your application to render consistently across various web browsers and computing platforms.
<p/> You may also alternatively place a facetRef, iterator, or switcher inside of the panelGroupLayout and their resolved children will be treated as if they were direct children of the panelGroupLayout. If you don't want this behavior, you may wrap the children you want to be grouped in a group component. <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g., panelStretchLayout if: <html:ul> <html:li>layout="scroll"</html:li> <html:li>layout="vertical"</html:li> </html:ul> This component cannot be stretched by a parent layout component that stretches its children if: <html:ul> <html:li>layout="default"</html:li> <html:li>layout="horizontal"</html:li> </html:ul> </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 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 |
HALIGN_CENTER |
static java.lang.String |
HALIGN_END |
static org.apache.myfaces.trinidad.bean.PropertyKey |
HALIGN_KEY |
static java.lang.String |
HALIGN_LEFT |
static java.lang.String |
HALIGN_RIGHT |
static java.lang.String |
HALIGN_START |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static java.lang.String |
LANDMARK_BANNER |
static java.lang.String |
LANDMARK_COMPLEMENTARY |
static java.lang.String |
LANDMARK_CONTENTINFO |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LANDMARK_KEY |
static java.lang.String |
LANDMARK_MAIN |
static java.lang.String |
LANDMARK_NAVIGATION |
static java.lang.String |
LANDMARK_NONE |
static java.lang.String |
LANDMARK_SEARCH |
static java.lang.String |
LAYOUT_DEFAULT |
static java.lang.String |
LAYOUT_HORIZONTAL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LAYOUT_KEY |
static java.lang.String |
LAYOUT_SCROLL |
static java.lang.String |
LAYOUT_VERTICAL |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static java.lang.String |
SEPARATOR_FACET |
static org.apache.myfaces.trinidad.bean.PropertyKey |
SHORT_DESC_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
STYLE_CLASS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
THEME_KEY Deprecated. |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
UNSECURE_KEY |
static java.lang.String |
VALIGN_BASELINE |
static java.lang.String |
VALIGN_BOTTOM |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VALIGN_KEY |
static java.lang.String |
VALIGN_MIDDLE |
static java.lang.String |
VALIGN_TOP |
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 | |
---|---|
|
RichPanelGroupLayout() Construct an instance of the RichPanelGroupLayout. |
protected |
RichPanelGroupLayout(java.lang.String rendererType) Construct an instance of the RichPanelGroupLayout. |
Method Summary | |
---|---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
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. |
java.lang.String |
getFamily() |
java.lang.String |
getHalign() Gets the horizontal alignment for horizonal, vertical and scroll layouts. |
java.lang.String |
getInlineStyle() Gets the CSS styles to use for this component. |
java.lang.String |
getLandmark() Gets Specifies the WAI-ARIA landmark role for this panelGroupLayout. |
java.lang.String |
getLayout() Gets the type of layout. |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
javax.faces.component.UIComponent |
getSeparator() Content to be rendered once between each of the other children. |
java.lang.String |
getShortDesc() Gets the short description of the component. |
java.lang.String |
getStyleClass() Gets a CSS style class to use for this component. |
java.lang.String |
getTheme() Deprecated. The theme attribute on af:panelGroupLayout and af:panelStretchLayout is deprecated. (It will be kept around until ER 7480937 is implemented.) Ideally, only the theme attribute of the af:decorativeBox and af:document tags should be needed. |
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. |
java.lang.String |
getValign() Gets the vertical alignment of a horizontal layout. |
boolean |
isClientComponent() Gets whether a client-side component will be generated. |
boolean |
isVisible() Gets the visibility of the component. |
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 |
setHalign(java.lang.String halign) Sets the horizontal alignment for horizonal, vertical and scroll layouts. |
void |
setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component. |
void |
setLandmark(java.lang.String landmark) Sets Specifies the WAI-ARIA landmark role for this panelGroupLayout. |
void |
setLayout(java.lang.String layout) Sets the type of layout. |
void |
setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
void |
setSeparator(javax.faces.component.UIComponent separatorFacet) Content to be rendered once between each of the other children. |
void |
setShortDesc(java.lang.String shortDesc) Sets the short description of the component. |
void |
setStyleClass(java.lang.String styleClass) Sets a CSS style class to use for this component. |
void |
setTheme(java.lang.String theme) Deprecated. The theme attribute on af:panelGroupLayout and af:panelStretchLayout is deprecated. (It will be kept around until ER 7480937 is implemented.) Ideally, only the theme attribute of the af:decorativeBox and af:document tags should be needed. |
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 |
setValign(java.lang.String valign) Sets the vertical alignment of a horizontal layout. |
void |
setVisible(boolean visible) Sets the visibility of the component. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, 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, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, 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, 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 java.lang.String LAYOUT_DEFAULT
public static final java.lang.String LAYOUT_HORIZONTAL
public static final java.lang.String LAYOUT_VERTICAL
public static final java.lang.String LAYOUT_SCROLL
public static final java.lang.String VALIGN_MIDDLE
public static final java.lang.String VALIGN_TOP
public static final java.lang.String VALIGN_BOTTOM
public static final java.lang.String VALIGN_BASELINE
public static final java.lang.String HALIGN_START
public static final java.lang.String HALIGN_CENTER
public static final java.lang.String HALIGN_END
public static final java.lang.String HALIGN_LEFT
public static final java.lang.String HALIGN_RIGHT
public static final java.lang.String LANDMARK_NONE
public static final java.lang.String LANDMARK_BANNER
public static final java.lang.String LANDMARK_COMPLEMENTARY
public static final java.lang.String LANDMARK_CONTENTINFO
public static final java.lang.String LANDMARK_MAIN
public static final java.lang.String LANDMARK_NAVIGATION
public static final java.lang.String LANDMARK_SEARCH
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
@Deprecated
public static final org.apache.myfaces.trinidad.bean.PropertyKey THEME_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LAYOUT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALIGN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HALIGN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LANDMARK_KEY
public static final java.lang.String SEPARATOR_FACET
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichPanelGroupLayout()
protected RichPanelGroupLayout(java.lang.String rendererType)
Method Detail |
---|
public final javax.faces.component.UIComponent getSeparator()
public final void setSeparator(javax.faces.component.UIComponent separatorFacet)
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 value
@Deprecated
public final java.lang.String getTheme()
@Deprecated
public final void setTheme(java.lang.String theme)
theme
- the new theme valuepublic final java.lang.String getLayout()
public final void setLayout(java.lang.String layout)
layout
- the new layout valuepublic final java.lang.String getValign()
public final void setValign(java.lang.String valign)
valign
- the new valign valuepublic final java.lang.String getHalign()
public final void setHalign(java.lang.String halign)
halign
- the new halign valuepublic final java.lang.String getLandmark()
public final void setLandmark(java.lang.String landmark)
landmark
- the new landmark 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.7.0) E10684-08 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |