|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
com.sun.webui.jsf.component.WebuiComponent
com.sun.webui.jsf.component.TableColumnBase
com.sun.webui.jsf.component.TableColumn
public class TableColumn
Component that represents a table column.
The tableColumn component provides a layout mechanism for displaying columns of data. UI guidelines describe specific behavior that can applied to the rows and columns of data such as sorting, filtering, pagination, selection, and custom user actions. In addition, UI guidelines also define sections of the table that can be used for titles, row group headers, and placement of pre-defined and user defined actions.
Note: Column headers and footers are rendered by TableRowGroupRenderer. Table column footers are rendered by TableRenderer.
Note: To see the messages logged by this class, set the following global defaults in your JDK's "jre/lib/logging.properties" file.
java.util.logging.ConsoleHandler.level = FINE com.sun.web.ui.component.TableColumn.level = FINE
See TLD docs for more information.
Field Summary | |
---|---|
static java.lang.String |
COLUMN_FOOTER_FACET
The facet name for the column footer. |
static java.lang.String |
COLUMN_FOOTER_ID
The component id for the column footer. |
static java.lang.String |
COLUMN_HEADER_FACET
The facet name for the column header. |
static java.lang.String |
COLUMN_HEADER_ID
The component id for the column header. |
static java.lang.String |
EMBEDDED_ACTION_SEPARATOR_ICON_FACET
The facet name for the embedded action separator icon. |
static java.lang.String |
EMBEDDED_ACTION_SEPARATOR_ICON_ID
The component id for the embedded action separator icon. |
static java.lang.String |
EMPTY_CELL_ICON_FACET
The facet name for the empty cell icon. |
static java.lang.String |
EMPTY_CELL_ICON_ID
The component id for the empty cell icon. |
static java.lang.String |
FOOTER_FACET
The facet name for the footer area. |
static java.lang.String |
HEADER_FACET
The facet name for the header area. |
static java.lang.String |
TABLE_COLUMN_FOOTER_FACET
The facet name for the table column footer. |
static java.lang.String |
TABLE_COLUMN_FOOTER_ID
The component id for the table column footer. |
static java.lang.String |
TABLE_FOOTER_FACET
The facet name for the table footer area. |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
TableColumn()
Default constructor |
Method Summary | |
---|---|
void |
clear()
Clear cached properties. |
java.lang.String |
getAlign()
Get the horizontal alignment for the cell. |
int |
getColumnCount()
Get the number of columns found for this component that have a rendered property of true. |
javax.faces.component.UIComponent |
getColumnFooter()
Get column footer. |
javax.faces.component.UIComponent |
getColumnHeader()
Get column header. |
javax.faces.component.UIComponent |
getEmbeddedActionSeparatorIcon()
Get separator icon for embedded actions. |
javax.faces.component.UIComponent |
getEmptyCellIcon()
Get the icon used to display inapplicable or unexpectedly empty cells. |
java.lang.String |
getExtraFooterHtml()
Extra HTML code to be appended to the <td> HTML element that
is rendered for the column footer. |
java.lang.String |
getExtraHeaderHtml()
Extra HTML code to be appended to the <th> HTML element that
is rendered for the column header. |
java.lang.String |
getExtraTableFooterHtml()
Extra HTML code to be appended to the <td> HTML element that
is rendered for the table column footer. |
java.lang.String |
getFamily()
Return the family for this component. |
com.sun.data.provider.SortCriteria |
getSortCriteria()
Get SortCriteria used for sorting the contents of a TableDataProvider. |
java.lang.String |
getSortToolTipAugment(boolean descending)
Get sort tool tip augment based on the value given to the align property of the tableColumn component. |
Table |
getTableAncestor()
Get the closest Table ancestor that encloses this component. |
TableColumn |
getTableColumnAncestor()
Get the closest TableColumn ancestor that encloses this component. |
javax.faces.component.UIComponent |
getTableColumnFooter()
Get table column footer. |
java.lang.String |
getTableFooterText()
The text to be displayed in the table column footer. |
TableRowGroup |
getTableRowGroupAncestor()
Get the closest TableRowGroup ancestor that encloses this component. |
void |
restoreState(javax.faces.context.FacesContext _context,
java.lang.Object _state)
Restore the state of this component. |
java.lang.Object |
saveState(javax.faces.context.FacesContext _context)
Save the state of this component. |
void |
setExtraFooterHtml(java.lang.String extraFooterHtml)
Extra HTML code to be appended to the <td> HTML element that
is rendered for the column footer. |
void |
setExtraHeaderHtml(java.lang.String extraHeaderHtml)
Extra HTML code to be appended to the <th> HTML element that
is rendered for the column header. |
void |
setExtraTableFooterHtml(java.lang.String extraTableFooterHtml)
Extra HTML code to be appended to the <td> HTML element that
is rendered for the table column footer. |
void |
setTableFooterText(java.lang.String tableFooterText)
The text to be displayed in the table column footer. |
Methods inherited from class com.sun.webui.jsf.component.WebuiComponent |
---|
processDecodes, processUpdates, processValidators, setId, setRendered |
Methods inherited from class javax.faces.component.UIComponentBase |
---|
broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, restoreAttachedState, saveAttachedState, setParent, setRendererType, setTransient, setValueBinding, setValueExpression |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getContainerClientId |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String COLUMN_FOOTER_ID
public static final java.lang.String COLUMN_FOOTER_FACET
public static final java.lang.String COLUMN_HEADER_ID
public static final java.lang.String COLUMN_HEADER_FACET
public static final java.lang.String EMBEDDED_ACTION_SEPARATOR_ICON_ID
public static final java.lang.String EMBEDDED_ACTION_SEPARATOR_ICON_FACET
public static final java.lang.String EMPTY_CELL_ICON_ID
public static final java.lang.String EMPTY_CELL_ICON_FACET
public static final java.lang.String FOOTER_FACET
public static final java.lang.String HEADER_FACET
public static final java.lang.String TABLE_COLUMN_FOOTER_ID
public static final java.lang.String TABLE_COLUMN_FOOTER_FACET
public static final java.lang.String TABLE_FOOTER_FACET
Constructor Detail |
---|
public TableColumn()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIComponent
public void clear()
Note: Properties may have been cached via the apply request values, validate, and update phases and must be re-evaluated during the render response phase (e.g., the underlying DataProvider may have changed). This cannot always be done via encodeBegin because the component's parent may need to obtain updated properties before this component is rendered.
clear
in class TableColumnBase
public Table getTableAncestor()
public TableColumn getTableColumnAncestor()
public int getColumnCount()
public TableRowGroup getTableRowGroupAncestor()
public java.lang.String getAlign()
Note: If the align property is specified, it is returned as is. However, if the alignKey property is provided, alignment is based on the object type of the data element. For example, Date and Number objects are aligned using "right", Character and String objects are aligned using "left", and Boolean objects are aligned using "center". Note that select columns are aligned using "center" by default.
getAlign
in class TableColumnBase
public javax.faces.component.UIComponent getColumnFooter()
public javax.faces.component.UIComponent getColumnHeader()
public javax.faces.component.UIComponent getTableColumnFooter()
public javax.faces.component.UIComponent getEmptyCellIcon()
Note: UI guidelines suggest not to use this for a value that is truly null, such as an empty alarm cell or a comment field which is blank, neither of which should have the dash image. Further, it is recomended not to use the dash image for cells that contain user interface elements such as checkboxes or drop-down lists when these elements are not applicable. Instead, simply do not display the user interface element.
public javax.faces.component.UIComponent getEmbeddedActionSeparatorIcon()
public com.sun.data.provider.SortCriteria getSortCriteria()
Note: If the sortKey attribute resolves to a SortCriteria object, it is returned as is. However, if there is a value binding, and it's not null, a ValueBindingSortCriteria object is created. If there is no value binding, a FieldIdSortCriteria object is created.
public java.lang.String getSortToolTipAugment(boolean descending)
descending
- Flag indicating descending sort.
public java.lang.String getExtraFooterHtml()
<td>
HTML element that
is rendered for the column footer. Use only code that is valid in an HTML
<td>
element. The code you specify is inserted in the HTML
element, and is not checked for validity. For example, you might set this
attribute to "nowrap=`nowrap'"
.
public void setExtraFooterHtml(java.lang.String extraFooterHtml)
<td>
HTML element that
is rendered for the column footer. Use only code that is valid in an HTML
<td>
element. The code you specify is inserted in the HTML
element, and is not checked for validity. For example, you might set this
attribute to "nowrap=`nowrap'"
.
public java.lang.String getExtraHeaderHtml()
<th>
HTML element that
is rendered for the column header. Use only code that is valid in an HTML
<td>
element. The code you specify is inserted in the HTML
element, and is not checked for validity. For example, you might set this
attribute to "nowrap=`nowrap'"
.
public void setExtraHeaderHtml(java.lang.String extraHeaderHtml)
<th>
HTML element that
is rendered for the column header. Use only code that is valid in an HTML
<td>
element. The code you specify is inserted in the HTML
element, and is not checked for validity. For example, you might set this
attribute to "nowrap=`nowrap'"
.
public java.lang.String getExtraTableFooterHtml()
<td>
HTML element that
is rendered for the table column footer. Use only code that is valid in an HTML
<td>
element. The code you specify is inserted in the HTML
element, and is not checked for validity. For example, you might set this
attribute to "nowrap=`nowrap'"
.
public void setExtraTableFooterHtml(java.lang.String extraTableFooterHtml)
<td>
HTML element that
is rendered for the table column footer. Use only code that is valid in an HTML
<td>
element. The code you specify is inserted in the HTML
element, and is not checked for validity. For example, you might set this
attribute to "nowrap=`nowrap'"
.
public java.lang.String getTableFooterText()
public void setTableFooterText(java.lang.String tableFooterText)
public void restoreState(javax.faces.context.FacesContext _context, java.lang.Object _state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class TableColumnBase
public java.lang.Object saveState(javax.faces.context.FacesContext _context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class TableColumnBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |