Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.3.0)
E17488-04


oracle.adf.view.rich.component.rich.layout
Class RichGridCell

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXPanel
                  extended by oracle.adf.view.rich.component.rich.layout.RichGridCell

All Implemented Interfaces:
java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RichGridCell
extends org.apache.myfaces.trinidad.component.UIXPanel

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>

Events:

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 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
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

 

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, addClientBehavior, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getContainerClientId, getDefaultEventName, 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, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, 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, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Field Detail

LANDMARK_NONE

public static final java.lang.String LANDMARK_NONE
See Also:
Constant Field Values

LANDMARK_BANNER

public static final java.lang.String LANDMARK_BANNER
See Also:
Constant Field Values

LANDMARK_COMPLEMENTARY

public static final java.lang.String LANDMARK_COMPLEMENTARY
See Also:
Constant Field Values

LANDMARK_CONTENTINFO

public static final java.lang.String LANDMARK_CONTENTINFO
See Also:
Constant Field Values

LANDMARK_MAIN

public static final java.lang.String LANDMARK_MAIN
See Also:
Constant Field Values

LANDMARK_NAVIGATION

public static final java.lang.String LANDMARK_NAVIGATION
See Also:
Constant Field Values

LANDMARK_SEARCH

public static final java.lang.String LANDMARK_SEARCH
See Also:
Constant Field Values

HALIGN_START

public static final java.lang.String HALIGN_START
See Also:
Constant Field Values

HALIGN_CENTER

public static final java.lang.String HALIGN_CENTER
See Also:
Constant Field Values

HALIGN_END

public static final java.lang.String HALIGN_END
See Also:
Constant Field Values

HALIGN_STRETCH

public static final java.lang.String HALIGN_STRETCH
See Also:
Constant Field Values

VALIGN_TOP

public static final java.lang.String VALIGN_TOP
See Also:
Constant Field Values

VALIGN_MIDDLE

public static final java.lang.String VALIGN_MIDDLE
See Also:
Constant Field Values

VALIGN_BOTTOM

public static final java.lang.String VALIGN_BOTTOM
See Also:
Constant Field Values

VALIGN_STRETCH

public static final java.lang.String VALIGN_STRETCH
See Also:
Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

INLINE_STYLE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey INLINE_STYLE_KEY

STYLE_CLASS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey STYLE_CLASS_KEY

SHORT_DESC_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey SHORT_DESC_KEY

LANDMARK_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey LANDMARK_KEY

WIDTH_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey WIDTH_KEY

COLUMN_SPAN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey COLUMN_SPAN_KEY

ROW_SPAN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey ROW_SPAN_KEY

HALIGN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey HALIGN_KEY

VALIGN_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VALIGN_KEY

MARGIN_START_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MARGIN_START_KEY

MARGIN_END_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MARGIN_END_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE
See Also:
Constant Field Values

Constructor Detail

RichGridCell

public RichGridCell()
Construct an instance of the RichGridCell.

RichGridCell

protected RichGridCell(java.lang.String rendererType)
Construct an instance of the RichGridCell.

Method Detail

getInlineStyle

public final java.lang.String getInlineStyle()
Gets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Returns:
the new inlineStyle value

setInlineStyle

public final void setInlineStyle(java.lang.String inlineStyle)
Sets the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
Parameters:
inlineStyle - the new inlineStyle value

getStyleClass

public final java.lang.String getStyleClass()
Gets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Returns:
the new styleClass value

setStyleClass

public final void setStyleClass(java.lang.String styleClass)
Sets a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
Parameters:
styleClass - the new styleClass value

getShortDesc

public final java.lang.String getShortDesc()
Gets the short description of the component. The shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. The behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.
Returns:
the new shortDesc value

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)
Sets the short description of the component. The shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. The behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips.
Parameters:
shortDesc - the new shortDesc value

getLandmark

public final java.lang.String getLandmark()
Gets Specifies the WAI-ARIA landmark role for this gridCell.
Returns:
the new landmark value

setLandmark

public final void setLandmark(java.lang.String landmark)
Sets Specifies the WAI-ARIA landmark role for this gridCell.
Parameters:
landmark - the new landmark value

getWidth

public final java.lang.String getWidth()
Gets Specifies a candidate for the width of the cell's column: Other considerations:
Returns:
the new width value

setWidth

public final void setWidth(java.lang.String width)
Sets Specifies a candidate for the width of the cell's column: Other considerations:
Parameters:
width - the new width value

getColumnSpan

public final int getColumnSpan()
Gets Specifies the number of columns wide this cell will consume (see the "width" documentation for columnSpan impact).
Returns:
the new columnSpan value

setColumnSpan

public final void setColumnSpan(int columnSpan)
Sets Specifies the number of columns wide this cell will consume (see the "width" documentation for columnSpan impact).
Parameters:
columnSpan - the new columnSpan value

getRowSpan

public final int getRowSpan()
Gets Specifies the number of rows tall this cell will consume.
Returns:
the new rowSpan value

setRowSpan

public final void setRowSpan(int rowSpan)
Sets Specifies the number of rows tall this cell will consume.
Parameters:
rowSpan - the new rowSpan value

getHalign

public final java.lang.String getHalign()
Gets Specifies the horizontal alignment for this cell's anchor point within the cell's coordinates:
Returns:
the new halign value

setHalign

public final void setHalign(java.lang.String halign)
Sets Specifies the horizontal alignment for this cell's anchor point within the cell's coordinates:
Parameters:
halign - the new halign value

getValign

public final java.lang.String getValign()
Gets Specifies the vertical alignment for this cell's anchor point within the cell's coordinates:
Returns:
the new valign value

setValign

public final void setValign(java.lang.String valign)
Sets Specifies the vertical alignment for this cell's anchor point within the cell's coordinates:
Parameters:
valign - the new valign value

getMarginStart

public final java.lang.String getMarginStart()
Gets Specifies a candidate for the amount of space that will be added before this cell's first column. Other cells in this cell's first column position could provide their own candidates via their marginStart values. Other cells from the previous column could provide their own candidates via their marginEnd values). Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%"). The margin candidates will be resolved using the largest value of the first unit type encountered (conflicting unit types will be ignored).
Returns:
the new marginStart value

setMarginStart

public final 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. Other cells in this cell's first column position could provide their own candidates via their marginStart values. Other cells from the previous column could provide their own candidates via their marginEnd values). Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%"). The margin candidates will be resolved using the largest value of the first unit type encountered (conflicting unit types will be ignored).
Parameters:
marginStart - the new marginStart value

getMarginEnd

public final java.lang.String getMarginEnd()
Gets Specifies a candidate for the amount of space that will be added after this cell's last column. Other cells in this cell's last column position could provide their own candidates via the marginEnd value. Other cells from the next column could provide their own candidates via their marginStart values). Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%"). The margin candidates will be resolved using the largest value of the first unit type encountered (conflicting unit types will be ignored).
Returns:
the new marginEnd value

setMarginEnd

public final 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. Other cells in this cell's last column position could provide their own candidates via the marginEnd value. Other cells from the next column could provide their own candidates via their marginStart values). Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%"). The margin candidates will be resolved using the largest value of the first unit type encountered (conflicting unit types will be ignored).
Parameters:
marginEnd - the new marginEnd value

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class org.apache.myfaces.trinidad.component.UIXPanel

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class org.apache.myfaces.trinidad.component.UIXPanel

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.3.0)
E17488-04


Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.