oracle.adf.view.faces.component.html
Class HtmlCellFormat

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--oracle.adf.view.faces.component.UIXComponent
              |
              +--oracle.adf.view.faces.component.UIXComponentBase
                    |
                    +--oracle.adf.view.faces.component.html.HtmlCellFormat

All Implemented Interfaces:

javax.faces.component.StateHolder

public class HtmlCellFormat

extends UIXComponentBase

CellFormatBeans are used to format cells in a RowLayoutBean. It is a container of other layout elements which allows its contents to take additional formatting, such as vertical alignment, width, or colspan.

Example:

 <tableLayout width="75%"
              borderWidth="3"
              cellSpacing="10"
              hAlign="center">
   <contents>
     <rowLayout hAlign="right">
       <contents>
         First Column
 
         <cellFormat vAlign="bottom">
           <contents>
             SecondColumn
           </contents>
         </cellFormat>
 
         <panelGroup type="horizontal">
           <contents>
             Third Column
             <objectSpacer height="100" width="1"/>
           </contents>
         </panelGroup>
 
       </contents>
     </rowLayout>
 
     <rowLayout>
       <contents>
 
         <header text="UIX Components"/>
 
         <cellFormat columnSpan="2">
           <contents>
             <header text="UIX Servlet"/>
           </contents>
         </cellFormat>
 
       </contents>
     </rowLayout>
   </contents>
 </tableLayout>

Field Summary

static PropertyKey	COLUMN_SPAN_KEY
static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static PropertyKey	HALIGN_KEY
static PropertyKey	HEADER_KEY
static PropertyKey	HEADERS_KEY
static PropertyKey	HEIGHT_KEY
static PropertyKey	INLINE_STYLE_KEY
static PropertyKey	ONCLICK_KEY
static PropertyKey	ONDBLCLICK_KEY
static PropertyKey	ONKEYDOWN_KEY
static PropertyKey	ONKEYPRESS_KEY
static PropertyKey	ONKEYUP_KEY
static PropertyKey	ONMOUSEDOWN_KEY
static PropertyKey	ONMOUSEMOVE_KEY
static PropertyKey	ONMOUSEOUT_KEY
static PropertyKey	ONMOUSEOVER_KEY
static PropertyKey	ONMOUSEUP_KEY
static PropertyKey	ROW_SPAN_KEY
static PropertyKey	SHORT_DESC_KEY
static PropertyKey	SHORT_TEXT_KEY
static PropertyKey	STYLE_CLASS_KEY
static FacesBean.Type	TYPE
static PropertyKey	VALIGN_KEY
static PropertyKey	WIDTH_KEY
static PropertyKey	WRAPPING_DISABLED_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Constructor Summary

HtmlCellFormat()
Construct an instance of the HtmlCellFormat.

Method Summary

protected FacesBean.Type	getBeanType()
int	getColumnSpan() Gets the number of cells wide the child layout element will be.
java.lang.String	getFamily()
java.lang.String	getHalign() Gets the horizontal alignment of the grid row elements.
java.lang.String	getHeaders() Gets Indicates which table cells are the headers for this cell.
java.lang.String	getHeight() Gets the preferred height of the enclosed layout elements.
Style	getInlineStyle() Gets the inline CSS style for this element
java.lang.String	getOnclick() Gets an onclick Javascript handler.
java.lang.String	getOndblclick() Gets an ondblclick Javascript handler.
java.lang.String	getOnkeydown() Gets an onkeydown Javascript handler.
java.lang.String	getOnkeypress() Gets an onkeypress Javascript handler.
java.lang.String	getOnkeyup() Gets an onkeyup Javascript handler.
java.lang.String	getOnmousedown() Gets an onmousedown Javascript handler.
java.lang.String	getOnmousemove() Gets an onmousemove Javascript handler.
java.lang.String	getOnmouseout() Gets an onmouseout Javascript handler.
java.lang.String	getOnmouseover() Gets an onmouseover Javascript handler.
java.lang.String	getOnmouseup() Gets an onmouseup Javascript handler.
int	getRowSpan() Gets the number of cells high the child layout element will be.
java.lang.String	getShortDesc() Gets the short description of the bean.
java.lang.String	getShortText() Gets This attribute should be used to provide an abbreviated form of the cell's content, and may be rendered by user agents when appropriate in place of the cell's content.
java.lang.String	getStyleClass() Gets the CSS style class of the bean.
java.lang.String	getValign() Gets the vertical alignment of the grid row elements.
java.lang.String	getWidth() Gets the preferred width of the enclosed layout elements.
boolean	isHeader() Gets Indicates whether or not this table cell is a header cell or a data cell.
boolean	isWrappingDisabled() Gets whether automatic text wrapping should be disabled for this cell.
void	setColumnSpan(int columnSpan) Sets the number of cells wide the child layout element will be.
void	setHalign(java.lang.String halign) Sets the horizontal alignment of the grid row elements.
void	setHeader(boolean header) Sets Indicates whether or not this table cell is a header cell or a data cell.
void	setHeaders(java.lang.String headers) Sets Indicates which table cells are the headers for this cell.
void	setHeight(java.lang.String height) Sets the preferred height of the enclosed layout elements.
void	setInlineStyle(Style inlineStyle) Sets the inline CSS style for this element
void	setOnclick(java.lang.String onclick) Sets an onclick Javascript handler.
void	setOndblclick(java.lang.String ondblclick) Sets an ondblclick Javascript handler.
void	setOnkeydown(java.lang.String onkeydown) Sets an onkeydown Javascript handler.
void	setOnkeypress(java.lang.String onkeypress) Sets an onkeypress Javascript handler.
void	setOnkeyup(java.lang.String onkeyup) Sets an onkeyup Javascript handler.
void	setOnmousedown(java.lang.String onmousedown) Sets an onmousedown Javascript handler.
void	setOnmousemove(java.lang.String onmousemove) Sets an onmousemove Javascript handler.
void	setOnmouseout(java.lang.String onmouseout) Sets an onmouseout Javascript handler.
void	setOnmouseover(java.lang.String onmouseover) Sets an onmouseover Javascript handler.
void	setOnmouseup(java.lang.String onmouseup) Sets an onmouseup Javascript handler.
void	setRowSpan(int rowSpan) Sets the number of cells high the child layout element will be.
void	setShortDesc(java.lang.String shortDesc) Sets the short description of the bean.
void	setShortText(java.lang.String shortText) Sets This attribute should be used to provide an abbreviated form of the cell's content, and may be rendered by user agents when appropriate in place of the cell's content.
void	setStyleClass(java.lang.String styleClass) Sets the CSS style class of the bean.
void	setValign(java.lang.String valign) Sets the vertical alignment of the grid row elements.
void	setWidth(java.lang.String width) Sets the preferred width of the enclosed layout elements.
void	setWrappingDisabled(boolean wrappingDisabled) Sets whether automatic text wrapping should be disabled for this cell.

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addFacesListener, broadcast, createFacesBean, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getIntProperty, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreState, saveState, setAttribute, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final FacesBean.Type TYPE

SHORT_TEXT_KEY

public static final PropertyKey SHORT_TEXT_KEY

HALIGN_KEY

public static final PropertyKey HALIGN_KEY

VALIGN_KEY

public static final PropertyKey VALIGN_KEY

WIDTH_KEY

public static final PropertyKey WIDTH_KEY

HEIGHT_KEY

public static final PropertyKey HEIGHT_KEY

COLUMN_SPAN_KEY

public static final PropertyKey COLUMN_SPAN_KEY

ROW_SPAN_KEY

public static final PropertyKey ROW_SPAN_KEY

WRAPPING_DISABLED_KEY

public static final PropertyKey WRAPPING_DISABLED_KEY

HEADERS_KEY

public static final PropertyKey HEADERS_KEY

HEADER_KEY

public static final PropertyKey HEADER_KEY

SHORT_DESC_KEY

public static final PropertyKey SHORT_DESC_KEY

STYLE_CLASS_KEY

public static final PropertyKey STYLE_CLASS_KEY

ONCLICK_KEY

public static final PropertyKey ONCLICK_KEY

ONDBLCLICK_KEY

public static final PropertyKey ONDBLCLICK_KEY

ONMOUSEDOWN_KEY

public static final PropertyKey ONMOUSEDOWN_KEY

ONMOUSEUP_KEY

public static final PropertyKey ONMOUSEUP_KEY

ONMOUSEOVER_KEY

public static final PropertyKey ONMOUSEOVER_KEY

ONMOUSEMOVE_KEY

public static final PropertyKey ONMOUSEMOVE_KEY

ONMOUSEOUT_KEY

public static final PropertyKey ONMOUSEOUT_KEY

ONKEYPRESS_KEY

public static final PropertyKey ONKEYPRESS_KEY

ONKEYDOWN_KEY

public static final PropertyKey ONKEYDOWN_KEY

ONKEYUP_KEY

public static final PropertyKey ONKEYUP_KEY

INLINE_STYLE_KEY

public static final PropertyKey INLINE_STYLE_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

HtmlCellFormat

public HtmlCellFormat()

Construct an instance of the HtmlCellFormat.

Method Detail

getShortText

public final java.lang.String getShortText()

Gets This attribute should be used to provide an abbreviated form of the cell's content, and may be rendered by user agents when appropriate in place of the cell's content. Abbreviated names should be short since user agents may render them repeatedly (especially if this cell is a header cell).

setShortText

public final void setShortText(java.lang.String shortText)

Sets This attribute should be used to provide an abbreviated form of the cell's content, and may be rendered by user agents when appropriate in place of the cell's content. Abbreviated names should be short since user agents may render them repeatedly (especially if this cell is a header cell).

getHalign

public final java.lang.String getHalign()

Gets the horizontal alignment of the grid row elements. The acceptable values are "center", "left", "right", "start", and "end".

setHalign

public final void setHalign(java.lang.String halign)

Sets the horizontal alignment of the grid row elements. The acceptable values are "center", "left", "right", "start", and "end".

getValign

public final java.lang.String getValign()

Gets the vertical alignment of the grid row elements. The acceptable values are "middle", "top", and "bottom".

setValign

public final void setValign(java.lang.String valign)

Sets the vertical alignment of the grid row elements. The acceptable values are "middle", "top", and "bottom".

getWidth

public final java.lang.String getWidth()

Gets the preferred width of the enclosed layout elements.

setWidth

public final void setWidth(java.lang.String width)

Sets the preferred width of the enclosed layout elements.

getHeight

public final java.lang.String getHeight()

Gets the preferred height of the enclosed layout elements.

setHeight

public final void setHeight(java.lang.String height)

Sets the preferred height of the enclosed layout elements.

getColumnSpan

public final int getColumnSpan()

Gets the number of cells wide the child layout element will be.

setColumnSpan

public final void setColumnSpan(int columnSpan)

Sets the number of cells wide the child layout element will be.

getRowSpan

public final int getRowSpan()

Gets the number of cells high the child layout element will be.

setRowSpan

public final void setRowSpan(int rowSpan)

Sets the number of cells high the child layout element will be.

isWrappingDisabled

public final boolean isWrappingDisabled()

Gets whether automatic text wrapping should be disabled for this cell.

setWrappingDisabled

public final void setWrappingDisabled(boolean wrappingDisabled)

Sets whether automatic text wrapping should be disabled for this cell.

getHeaders

public final java.lang.String getHeaders()

Gets Indicates which table cells are the headers for this cell. This attribute is used by screen readers to associate header information with data cells. This must be set to a space-separated list of IDs. Each ID must be the ID of a pertinent header cell.

setHeaders

public final void setHeaders(java.lang.String headers)

Sets Indicates which table cells are the headers for this cell. This attribute is used by screen readers to associate header information with data cells. This must be set to a space-separated list of IDs. Each ID must be the ID of a pertinent header cell.

isHeader

public final boolean isHeader()

Gets Indicates whether or not this table cell is a header cell or a data cell. Setting this attribute to 'true' will mark this cell as a header cell.

setHeader

public final void setHeader(boolean header)

Sets Indicates whether or not this table cell is a header cell or a data cell. Setting this attribute to 'true' will mark this cell as a header cell.

getShortDesc

public final java.lang.String getShortDesc()

Gets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

setShortDesc

public final void setShortDesc(java.lang.String shortDesc)

Sets the short description of the bean. This text is commonly used by user agents to display tooltip help text.

getStyleClass

public final java.lang.String getStyleClass()

Gets the CSS style class of the bean.

setStyleClass

public final void setStyleClass(java.lang.String styleClass)

Sets the CSS style class of the bean.

getOnclick

public final java.lang.String getOnclick()

Gets an onclick Javascript handler.

setOnclick

public final void setOnclick(java.lang.String onclick)

Sets an onclick Javascript handler.

getOndblclick

public final java.lang.String getOndblclick()

Gets an ondblclick Javascript handler.

setOndblclick

public final void setOndblclick(java.lang.String ondblclick)

Sets an ondblclick Javascript handler.

getOnmousedown

public final java.lang.String getOnmousedown()

Gets an onmousedown Javascript handler.

setOnmousedown

public final void setOnmousedown(java.lang.String onmousedown)

Sets an onmousedown Javascript handler.

getOnmouseup

public final java.lang.String getOnmouseup()

Gets an onmouseup Javascript handler.

setOnmouseup

public final void setOnmouseup(java.lang.String onmouseup)

Sets an onmouseup Javascript handler.

getOnmouseover

public final java.lang.String getOnmouseover()

Gets an onmouseover Javascript handler.

setOnmouseover

public final void setOnmouseover(java.lang.String onmouseover)

Sets an onmouseover Javascript handler.

getOnmousemove

public final java.lang.String getOnmousemove()

Gets an onmousemove Javascript handler.

setOnmousemove

public final void setOnmousemove(java.lang.String onmousemove)

Sets an onmousemove Javascript handler.

getOnmouseout

public final java.lang.String getOnmouseout()

Gets an onmouseout Javascript handler.

setOnmouseout

public final void setOnmouseout(java.lang.String onmouseout)

Sets an onmouseout Javascript handler.

getOnkeypress

public final java.lang.String getOnkeypress()

Gets an onkeypress Javascript handler.

setOnkeypress

public final void setOnkeypress(java.lang.String onkeypress)

Sets an onkeypress Javascript handler.

getOnkeydown

public final java.lang.String getOnkeydown()

Gets an onkeydown Javascript handler.

setOnkeydown

public final void setOnkeydown(java.lang.String onkeydown)

Sets an onkeydown Javascript handler.

getOnkeyup

public final java.lang.String getOnkeyup()

Gets an onkeyup Javascript handler.

setOnkeyup

public final void setOnkeyup(java.lang.String onkeyup)

Sets an onkeyup Javascript handler.

getInlineStyle

public final Style getInlineStyle()

Gets the inline CSS style for this element

setInlineStyle

public final void setInlineStyle(Style inlineStyle)

Sets the inline CSS style for this element

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase