|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-05 |
|||||||||
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.RichPanelDashboard
public class RichPanelDashboard
panelDashboard features:
<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 or panelSplitter if the dimensionsFrom attribute of this panelDashboard is set to "parent".</html:li> <html:li>This component organizes its children components into a grid based on the number of columns and the rowHeight. The child components that can be stretched inside of the panelDashboard include: <html:ul> <html:li><af:panelBox></html:li> <html:li><af:region></html:li> </html:ul> If you try to put any other component inside of this component (except for af:dataFlavor which can be used to allow discriminants of external drops), then the component hierarchy is illegal. </html:li> </html:ul> There are other ways in which you can control the geometry of this component when it is not being stretched by its ancestor: <html:ul> <html:li>You can specify dimensionsFrom="children" for the panelDashboard to be as tall as the number of visible rows multiplied by the rowHeight setting. When using this "children" setting, the topHeight attribute will still be honored (unless percent units are specified) but any height assignment (e.g. inlineStyle or styleClass) on the panelDashboard must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>You can also specify dimensionsFrom="parent" to make the panelDashboard get its dimensions from the inlineStyle and if not provided from there then from its parent component or if not provided from the parent then from the skin.</html:li> <html:li>Using dimensionsFrom="auto" will choose either "children" or "parent" depending on whether the panelDashboard is being stretched by its parent.</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 org.apache.myfaces.trinidad.bean.PropertyKey |
COLUMNS_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 |
DIMENSIONS_FROM_AUTO |
static java.lang.String |
DIMENSIONS_FROM_CHILDREN |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DIMENSIONS_FROM_KEY |
static java.lang.String |
DIMENSIONS_FROM_PARENT |
static org.apache.myfaces.trinidad.bean.PropertyKey |
DROP_LISTENER_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
INLINE_STYLE_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
PARTIAL_TRIGGERS_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ROW_HEIGHT_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 |
---|
bindings |
Constructor Summary | |
---|---|
|
RichPanelDashboard() Construct an instance of the RichPanelDashboard. |
protected |
RichPanelDashboard(java.lang.String rendererType) Construct an instance of the RichPanelDashboard. |
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. |
int |
getColumns() Gets the number of columns the width of the dashboard will be divided into |
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 |
getDimensionsFrom() Gets |
javax.el.MethodExpression |
getDropListener() Gets A method reference to a callback with the signature oracle.adf.view.rich.dnd.DnDAction method(oracle.adf.view.rich.event.DropEvent dropEvent) called when a drop occurs on the component. |
java.lang.String |
getFamily() |
java.lang.String |
getInlineStyle() Gets the CSS styles to use for this component. |
java.lang.String[] |
getPartialTriggers() Gets the IDs of the components that should trigger a partial update. |
java.lang.String |
getRowHeight() Gets the height of the rows of the grid layout as a CSS length. |
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.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 |
prepareOptimizedEncodingOfDeletedChild(javax.faces.context.FacesContext context, int deletedChildIndex) To be used by an action listener that is modifying the children of this panelDashboard. |
void |
prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context) To be used by an action listener on a component that also uses an af:panelDashboardBehavior type="insert". |
void |
prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context, int insertedChildIndex) To be used by an action listener on a component that also uses an af:panelDashboardBehavior type="insert". |
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 |
setColumns(int columns) Sets the number of columns the width of the dashboard will be divided into |
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 |
setDimensionsFrom(java.lang.String dimensionsFrom) Sets |
void |
setDropListener(javax.el.MethodExpression dropListener) Sets A method reference to a callback with the signature oracle.adf.view.rich.dnd.DnDAction method(oracle.adf.view.rich.event.DropEvent dropEvent) called when a drop occurs on the component. |
void |
setInlineStyle(java.lang.String inlineStyle) Sets the CSS styles to use for this component. |
void |
setPartialTriggers(java.lang.String[] partialTriggers) Sets the IDs of the components that should trigger a partial update. |
void |
setRowHeight(java.lang.String rowHeight) Sets the height of the rows of the grid layout as a CSS length. |
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 |
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, 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 DIMENSIONS_FROM_AUTO
public static final java.lang.String DIMENSIONS_FROM_CHILDREN
public static final java.lang.String DIMENSIONS_FROM_PARENT
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey DIMENSIONS_FROM_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMNS_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_HEIGHT_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey DROP_LISTENER_KEY
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 COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichPanelDashboard()
protected RichPanelDashboard(java.lang.String rendererType)
Method Detail |
---|
public void prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context)
context
- the FacesContextpublic void prepareOptimizedEncodingOfInsertedChild(javax.faces.context.FacesContext context, int insertedChildIndex)
context
- the FacesContextinsertedChildIndex
- the index of the child that has been insertedpublic void prepareOptimizedEncodingOfDeletedChild(javax.faces.context.FacesContext context, int deletedChildIndex)
context
- the FacesContextdeletedChildIndex
- the index of the child that has been deletedpublic final java.lang.String getDimensionsFrom()
determines how the component will handle geometry management. This specifies where the dimensions of the panelDashboard come from:
<html:ul> <html:li>auto - either "children" or "parent", depending on the container the panelDashboard is inside; if the panelDashboard is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used</html:li> <html:li>children - the panelDashboard will get its dimensions from the children (rowHeight will still be honored so the contents of the rows will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the panelDashboard must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>parent (the default) - the panelDashboard will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin</html:li> </html:ul>public final void setDimensionsFrom(java.lang.String dimensionsFrom)
determines how the component will handle geometry management. This specifies where the dimensions of the panelDashboard come from:
<html:ul> <html:li>auto - either "children" or "parent", depending on the container the panelDashboard is inside; if the panelDashboard is being stretched by its ancestor then "parent" will be used, otherwise "children" will be used</html:li> <html:li>children - the panelDashboard will get its dimensions from the children (rowHeight will still be honored so the contents of the rows will be constrained to those dimensions unless percent units are specified and then the default value will be used instead). Note that any height assignment (e.g. inlineStyle or styleClass) on the panelDashboard must be omitted or else there would be a competing assignment for how tall the component will be.</html:li> <html:li>parent (the default) - the panelDashboard will get its dimensions from the inlineStyle and if not provided from there then from its parent or if not provided from the parent then from the skin</html:li> </html:ul>dimensionsFrom
- the new dimensionsFrom valuepublic final int getColumns()
public final void setColumns(int columns)
columns
- the new columns valuepublic final java.lang.String getRowHeight()
public final void setRowHeight(java.lang.String rowHeight)
rowHeight
- the new rowHeight valuepublic final javax.el.MethodExpression getDropListener()
public final void setDropListener(javax.el.MethodExpression dropListener)
dropListener
- the new dropListener valuepublic 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-05 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |