|
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.RichGridCell
public class RichGridCell
The gridCell control is a layout element that serves as a cell of a gridRow component. <section name="Geometry_Management"> <html:ul> <html:li>This component must be a child of a gridRow; it is not valid to use a gridCell inside of another kind of layout container.</html:li> <html:li>This component can stretch a child component if (1) it is the only component inside of the gridCell, (2) the cell's "halign" is "stretch", (3) the cell's "valign" is "stretch", (4) the effective width of the cell is non-auto, and (5) if the effective height of the cell is non-auto.</html:li> <html:li>Use only non-geometry style properties like background-color; some of the invalid style (e.g. inlineStyle) properties for a gridCell include width, height, position, display, margin, etc. because the geometry must be managed by the grid structure instead.</html:li> <html:li>Beware that if you attempt to use width="auto", halign="center", halign="end" in conjunction with cell content that uses unstable, percentage-based widths, you may experience different results in different browsers. If you wish to use these settings, be sure to constraint the width of that cell content.</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 |
COLUMN_SPAN_KEY |
static java.lang.String |
COMPONENT_FAMILY |
static java.lang.String |
COMPONENT_TYPE |
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_START |
static java.lang.String |
HALIGN_STRETCH |
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 org.apache.myfaces.trinidad.bean.PropertyKey |
MARGIN_END_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
MARGIN_START_KEY |
static org.apache.myfaces.trinidad.bean.PropertyKey |
ROW_SPAN_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 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_STRETCH |
static java.lang.String |
VALIGN_TOP |
static org.apache.myfaces.trinidad.bean.PropertyKey |
WIDTH_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 | |
---|---|
|
RichGridCell() Construct an instance of the RichGridCell. |
protected |
RichGridCell(java.lang.String rendererType) Construct an instance of the RichGridCell. |
Method Summary | |
---|---|
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
int |
getColumnSpan() Gets Specifies the number of columns wide this cell will consume (see the "width" documentation for columnSpan impact). |
java.lang.String |
getFamily() |
java.lang.String |
getHalign() Gets Specifies the horizontal alignment for this cell's anchor point within the cell's coordinates: "start" (default): aligned to the "start" side of the cell (i.e. |
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 gridCell. |
java.lang.String |
getMarginEnd() Gets Specifies a candidate for the amount of space that will be added after this cell's last column. |
java.lang.String |
getMarginStart() Gets Specifies a candidate for the amount of space that will be added before this cell's first column. |
int |
getRowSpan() Gets Specifies the number of rows tall this cell will consume. |
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 |
getValign() Gets Specifies the vertical alignment for this cell's anchor point within the cell's coordinates: "top" (default): aligned to the "top" side of the cell "middle": aligned to the middle of the cell "bottom": aligned to the "bottom" side of the cell "stretch": if (1) the cell has a non-auto width, (2) the row has a non-auto height, (3) "halign" is also set to "stretch", and (4) if there is only one child component within the gridCell, then the cell will attempt to anchor the child component to all sides of the cell's coordinates. |
java.lang.String |
getWidth() Gets Specifies a candidate for the width of the cell's column: "dontCare": let other cells in this column define the candidates for width "auto": let the browser draw the components in this column and then have the panelGridLayout component ask the browser for the widths of these components and adjust the layout accordingly. |
void |
setColumnSpan(int columnSpan) Sets Specifies the number of columns wide this cell will consume (see the "width" documentation for columnSpan impact). |
void |
setHalign(java.lang.String halign) Sets Specifies the horizontal alignment for this cell's anchor point within the cell's coordinates: "start" (default): aligned to the "start" side of the cell (i.e. |
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 gridCell. |
void |
setMarginEnd(java.lang.String marginEnd) Sets Specifies a candidate for the amount of space that will be added after this cell's last column. |
void |
setMarginStart(java.lang.String marginStart) Sets Specifies a candidate for the amount of space that will be added before this cell's first column. |
void |
setRowSpan(int rowSpan) Sets Specifies the number of rows tall this cell will consume. |
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 |
setValign(java.lang.String valign) Sets Specifies the vertical alignment for this cell's anchor point within the cell's coordinates: "top" (default): aligned to the "top" side of the cell "middle": aligned to the middle of the cell "bottom": aligned to the "bottom" side of the cell "stretch": if (1) the cell has a non-auto width, (2) the row has a non-auto height, (3) "halign" is also set to "stretch", and (4) if there is only one child component within the gridCell, then the cell will attempt to anchor the child component to all sides of the cell's coordinates. |
void |
setWidth(java.lang.String width) Sets Specifies a candidate for the width of the cell's column: "dontCare": let other cells in this column define the candidates for width "auto": let the browser draw the components in this column and then have the panelGridLayout component ask the browser for the widths of these components and adjust the layout accordingly. |
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 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 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_STRETCH
public static final java.lang.String VALIGN_TOP
public static final java.lang.String VALIGN_MIDDLE
public static final java.lang.String VALIGN_BOTTOM
public static final java.lang.String VALIGN_STRETCH
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey LANDMARK_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_SPAN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_SPAN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey HALIGN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey VALIGN_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MARGIN_START_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey MARGIN_END_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 java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public RichGridCell()
protected RichGridCell(java.lang.String rendererType)
Method Detail |
---|
public final java.lang.String getShortDesc()
public final void setShortDesc(java.lang.String shortDesc)
shortDesc
- the new shortDesc valuepublic final java.lang.String getLandmark()
public final void setLandmark(java.lang.String landmark)
landmark
- the new landmark valuepublic final java.lang.String getWidth()
public final void setWidth(java.lang.String width)
width
- the new width valuepublic final int getColumnSpan()
public final void setColumnSpan(int columnSpan)
columnSpan
- the new columnSpan valuepublic final int getRowSpan()
public final void setRowSpan(int rowSpan)
rowSpan
- the new rowSpan valuepublic final java.lang.String getHalign()
public final void setHalign(java.lang.String halign)
halign
- the new halign valuepublic final java.lang.String getValign()
public final void setValign(java.lang.String valign)
valign
- the new valign valuepublic final java.lang.String getMarginStart()
public final void setMarginStart(java.lang.String marginStart)
marginStart
- the new marginStart valuepublic final java.lang.String getMarginEnd()
public final void setMarginEnd(java.lang.String marginEnd)
marginEnd
- the new marginEnd 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 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 |