|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 12c Release 1 (12.1.2.0.0) E23185-01 |
|||||||||
| 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.RichPanelGridLayout
public class RichPanelGridLayout
The panelGridLayout component is a layout container component that uses one or more gridRow components to describe the rows of a grid layout structure. Each row defines a height and margins. Each gridRow uses one or more gridCell components to describe the cells for columns in that row of the grid layout structure. Each cell defines width, margins, column span, row span, horizontal alignment, and vertical alignment. <p/> The panelGridLayout component is not meant to be used to display data table content. For more information about this, see the Accessibility Guidelines section. <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 panelGridLayout and their resolved children will be treated as if they were direct children of the panelGridLayout--those children must resolve to gridRow components. <section name="Geometry_Management"> <html:ul> <html:li>This component can be stretched by a parent layout component that stretches its children, e.g. panelSplitter.</html:li> <html:li>This component uses gridRow children components to define row structures within the grid layout.</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 event 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 String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
static org.apache.myfaces.trinidad.bean.PropertyKey |
CUSTOMIZATION_ID_KEYDeprecated. |
static String |
DIMENSIONS_FROM_AUTO |
static String |
DIMENSIONS_FROM_CHILDREN |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DIMENSIONS_FROM_KEY |
static String |
DIMENSIONS_FROM_PARENT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static String |
LANDMARK_BANNER |
static String |
LANDMARK_COMPLEMENTARY |
static String |
LANDMARK_CONTENTINFO |
static org.apache.myfaces.trinidad.bean.PropertyKey |
LANDMARK_KEY |
static String |
LANDMARK_MAIN |
static String |
LANDMARK_NAVIGATION |
static String |
LANDMARK_NONE |
static String |
LANDMARK_SEARCH |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
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.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 |
|---|
ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY |
| Constructor Summary | |
|---|---|
|
RichPanelGridLayout()Construct an instance of the RichPanelGridLayout. |
protected |
RichPanelGridLayout(String rendererType)Construct an instance of the RichPanelGridLayout. |
| Method Summary | |
|---|---|
void |
addClientBehavior(String eventName, javax.faces.component.behavior.ClientBehavior behavior) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
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() |
String |
getDimensionsFrom()Gets |
Collection<String> |
getEventNames() |
String |
getFamily() |
String |
getInlineStyle()Gets the CSS styles to use for this component. |
String |
getLandmark()Gets Specifies the WAI-ARIA landmark role for this panelGridLayout. |
String[] |
getPartialTriggers()Gets the IDs of the components that should trigger a partial update. |
String |
getShortDesc()Gets the short description of the component. |
String |
getStyleClass()Gets a CSS style class to use for this component. |
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 |
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 |
setDimensionsFrom(String dimensionsFrom)Sets |
void |
setInlineStyle(String inlineStyle)Sets the CSS styles to use for this component. |
void |
setLandmark(String landmark)Sets Specifies the WAI-ARIA landmark role for this panelGridLayout. |
void |
setPartialTriggers(String[] partialTriggers)Sets the IDs of the components that should trigger a partial update. |
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. |
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. |
| Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
|---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, 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 |
| 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, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String LANDMARK_NONE
public static final String LANDMARK_BANNER
public static final String LANDMARK_COMPLEMENTARY
public static final String LANDMARK_CONTENTINFO
public static final String LANDMARK_MAIN
public static final String LANDMARK_NAVIGATION
public static final String LANDMARK_SEARCH
public static final String DIMENSIONS_FROM_AUTO
public static final String DIMENSIONS_FROM_CHILDREN
public static final String DIMENSIONS_FROM_PARENT
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 org.apache.myfaces.trinidad.bean.PropertyKey LANDMARK_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DIMENSIONS_FROM_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
| Constructor Detail |
|---|
public RichPanelGridLayout()
protected RichPanelGridLayout(String rendererType)
| Method Detail |
|---|
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 final String getLandmark()
public final void setLandmark(String landmark)
landmark - the new landmark valuepublic final String getDimensionsFrom()
determines how the component will handle geometry management. This specifies where the dimensions of the root element of the panelGridLayout will come from:
public final void setDimensionsFrom(String dimensionsFrom)
determines how the component will handle geometry management. This specifies where the dimensions of the root element of the panelGridLayout will come from:
dimensionsFrom - the new dimensionsFrom valuepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class org.apache.myfaces.trinidad.component.UIXComponentBasepublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolderpublic Map<String,List<javax.faces.component.behavior.ClientBehavior>> getClientBehaviors()
getClientBehaviors in interface javax.faces.component.behavior.ClientBehaviorHoldergetClientBehaviors 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.ClientBehaviorHolderaddClientBehavior in class org.apache.myfaces.trinidad.component.UIXComponentBasepublic String getFamily()
getFamily in class org.apache.myfaces.trinidad.component.UIXPanelprotected 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 12c Release 1 (12.1.2.0.0) E23185-01 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright © 2013 Oracle Corporation. All Rights Reserved.