com.sun.webui.jsf.component.TableColumn Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2007-2018 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://oss.oracle.com/licenses/CDDL+GPL-1.1
* or LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.webui.jsf.component;
import com.sun.faces.annotation.Component;
import com.sun.faces.annotation.Property;
import com.sun.data.provider.SortCriteria;
import com.sun.data.provider.FieldKey;
import com.sun.data.provider.impl.FieldIdSortCriteria;
import com.sun.webui.jsf.faces.ValueBindingSortCriteria;
import com.sun.webui.theme.Theme;
import com.sun.webui.jsf.theme.ThemeImages;
import com.sun.webui.jsf.util.LogUtil;
import com.sun.webui.jsf.util.ThemeUtilities;
import java.util.ArrayList;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import javax.el.ValueExpression;
import javax.faces.component.UIComponent;
import javax.faces.component.UIComponentBase;
import javax.faces.component.NamingContainer;
import javax.faces.context.FacesContext;
/**
* 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.
*
*/
@Component(type = "com.sun.webui.jsf.TableColumn",
family = "com.sun.webui.jsf.TableColumn", displayName = "Column", tagName = "tableColumn",
helpKey = "projrave_ui_elements_palette_wdstk-jsf1.2_column")
public class TableColumn extends UIComponentBase implements NamingContainer {
/** The component id for the column footer. */
public static final String COLUMN_FOOTER_ID = "_columnFooter"; //NOI18N
/** The facet name for the column footer. */
public static final String COLUMN_FOOTER_FACET = "columnFooter"; //NOI18N
/** The component id for the column header. */
public static final String COLUMN_HEADER_ID = "_columnHeader"; //NOI18N
/** The facet name for the column header. */
public static final String COLUMN_HEADER_FACET = "columnHeader"; //NOI18N
/** The facet name for the header area. */
public static final String HEADER_FACET = "header"; //NOI18N
/** The component id for the embedded action separator icon. */
public static final String EMBEDDED_ACTION_SEPARATOR_ICON_ID =
"_embeddedActionSeparatorIcon"; //NOI18N
/** The facet name for the embedded action separator icon. */
public static final String EMBEDDED_ACTION_SEPARATOR_ICON_FACET =
"embeddedActionSeparatorIcon"; //NOI18N
/** The component id for the empty cell icon. */
public static final String EMPTY_CELL_ICON_ID = "_emptyCellIcon"; //NOI18N
/** The facet name for the empty cell icon. */
public static final String EMPTY_CELL_ICON_FACET = "emptyCellIcon"; //NOI18N
/** The facet name for the footer area. */
public static final String FOOTER_FACET = "footer"; //NOI18N
/** The component id for the table column footer. */
public static final String TABLE_COLUMN_FOOTER_ID = "_tableColumnFooter"; //NOI18N
/** The facet name for the table column footer. */
public static final String TABLE_COLUMN_FOOTER_FACET = "tableColumnFooter"; //NOI18N
/** The facet name for the table footer area. */
public static final String TABLE_FOOTER_FACET = "tableFooter"; //NOI18N
// The Table ancestor enclosing this component.
private Table tableAncestor = null;
// The TableColumn ancestor enclosing this component.
private TableColumn tableColumnAncestor = null;
// A List of TableColumn children found for this component.
private List tableColumnChildren = null;
// The TableRowGroup ancestor enclosing this component.
private TableRowGroup tableRowGroupAncestor = null;
// The number of columns to be rendered.
private int columnCount = -1;
// The number of rows to be rendered for headers and footers.
private int rowCount = -1;
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Tag attributes
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* ABBR gives an abbreviated version of the cell's content. This allows
* visual browsers to use the short form if space is limited, and
* non-visual browsers can give a cell's header information in an
* abbreviated form before rendering each cell.
*/
@Property(name = "abbr", displayName = "Abbreviation for Header Cell", isHidden = true, isAttribute = false)
private String abbr = null;
/**
* Use the align attribute to specify the horizontal alignment for
* the content of each cell in the column. Valid values are left,
* center, right, justify, and
* char. The default alignment is left. Setting the
* align attribute to char causes the cell's contents
* to be aligned on the character that you specify with the char
* attribute. For example, to align cell contents on colons, set
* align="char" and char=":" Some browsers do not
* support aligning on the character.
*/
@Property(name = "align", displayName = "Horizontal Alignment", category = "Appearance",
editorClassName = "com.sun.webui.jsf.component.propertyeditors.TableAlignEditor")
private String align = null;
/**
* Use the alignKey attribute to specify the FieldKey id or FieldKey
* to be used as an identifier for a specific data element on which to align the
* table cell data in the column. If alignKey specifies a
* FieldKey, the FieldKey is used as is; otherwise, a FieldKey is created using
* the alignKey value that you specify. Alignment is based on
* the object type of the data element. For example, Date and Number objects are
* aligned "right", Character and String objects are aligned "left", and Boolean
* objects are aligned "center". All columns, including select columns, are
* aligned "left" by default. Note that the align property overrides this value.
*/
@Property(name = "alignKey", displayName = "Horizontal Alignment Key", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private Object alignKey = null;
/**
* The AXIS attribute provides a method of categorizing cells. The
* attribute's value is a comma-separated list of category names. See the
* HTML 4.0 Recommendation's section on categorizing cells for an
* application of AXIS.
*/
@Property(name = "axis", displayName = "Category of Header Cell", category = "Advanced",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor", isHidden = true, isAttribute = false)
private String axis = null;
/**
* The BGCOLOR attribute suggests a background color for the cell. The
* combination of this attribute with can leave
* invisible or unreadable text on Netscape Navigator 2.x, which does not
* support BGCOLOR on table elements. BGCOLOR is dangerous even on
* supporting browsers, since most fail to override it when overriding
* other author-specified colors. Style sheets provide a safer, more
* flexible method of specifying a table's background color. This
* attribute is deprecated (in HTML 4.0) in favor of style sheets.
*/
@Property(name = "bgColor", displayName = "Cell Background Color", isHidden = true, isAttribute = false)
private String bgColor = null;
/**
* Use the char attribute to specify a character to use for
* horizontal alignment in each cell in the row. You must also set the
* align attribute to char to enable character alignment
* to be used. The default value for the char attribute is the
* decimal point of the current language, such as a period in English. The
* char HTML property is not supported by all browsers.
*/
@Property(name = "char", displayName = "Alignment Character", isHidden = true, isAttribute = false)
private String _char = null;
/**
* Use the charOff attribute to specify the offset of the first
* occurrence of the alignment character that is specified with the
* char attribute. The offset is the distance from the left cell
* border, in locales that read from left to right. The charOff
* attribute's value can be a number of pixels or a percentage of the cell's
* width. For example, charOff="50%" centers the alignment character
* horizontally in a cell. If charOff="25%", the first instance
* of the alignment character is placed at one fourth of the width of the cell.
*/
@Property(name = "charOff", displayName = "Alignment Character Offset", isHidden = true, isAttribute = false)
private String charOff = null;
/**
* The COLSPAN attribute of TD specifies the number of columns that are
* spanned by the cell. The default value is 1. The special value 0
* indicates that the cell spans all columns to the end of the table. The
* value 0 is ignored by most browsers, so authors may wish to calculate
* the exact number of rows or columns spanned and use that value.
*/
@Property(name = "colSpan", displayName = "Columns Spanned By the Cell", category = "Layout",
editorClassName = "com.sun.rave.propertyeditors.IntegerPropertyEditor", isAttribute = false)
private int colSpan = Integer.MIN_VALUE;
private boolean colSpan_set = false;
/**
* Use the descending attribute to specify that the first
* user-applied sort is descending. By default, the first time a user clicks a
* column's sort button or column header, the sort is ascending. Note that this
* not an initial sort. The data is initially displayed unsorted.
*/
@Property(name = "descending", displayName = "Is Descending", category = "Data")
private boolean descending = false;
private boolean descending_set = false;
/**
* Set the embeddedActions attribute to true when the column includes
* more than one embedded action. This attribute causes a separator image to be
* displayed between the action links. This attribute is overridden by the
* emptyCell attribute.
*/
@Property(name = "embeddedActions", displayName = "Is Embedded Actions", category = "Advanced")
private boolean embeddedActions = false;
private boolean embeddedActions_set = false;
/**
* Use the emptyCell attribute to cause a theme-specific image to be
* displayed when the content of a table cell is not applicable or is unexpectedly
* empty. You should not use this attribute for a value that is truly null, such
* as an empty alarm cell or a comment field that is blank. In addition, the image
* should not be used for cells that contain user interface elements such as
* checkboxes or drop-down lists when these elements are not applicable. Instead,
* the elements should simply not be displayed so the cell is left empty.
*/
@Property(name = "emptyCell", displayName = "Empty Cell", category = "Appearance")
private boolean emptyCell = false;
private boolean emptyCell_set = false;
/**
* Extra HTML code to be appended to the <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'".
*/
@Property(name = "extraFooterHtml", displayName = "Extra Footer HTML", category = "Advanced",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String extraFooterHtml = null;
/**
* Extra HTML code to be appended to the <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'".
*/
@Property(name = "extraHeaderHtml", displayName = "Extra Header HTML", category = "Advanced",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String extraHeaderHtml = null;
/**
* Extra HTML code to be appended to the <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'".
*/
@Property(name = "extraTableFooterHtml", displayName = "Extra Table Footer HTML",
category = "Advanced", editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String extraTableFooterHtml = null;
/**
* The text to be displayed in the column footer.
*/
@Property(name = "footerText", displayName = "Footer Text", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String footerText = null;
/**
* The text to be displayed in the column header.
*/
@Property(name = "headerText", displayName = "header Text", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String headerText = null;
/**
* The HEADERS attribute specifies the header cells that apply to the
* TD. The value is a space-separated list of the header cells' ID
* attribute values. The HEADERS attribute allows non-visual browsers to
* render the header information for a given cell.
*/
@Property(name = "headers", displayName = "List of Header Cells for Current Cell", category = "Advanced",
isHidden = true, editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor", isAttribute = false)
private String headers = null;
/**
* The number of pixels for the cell's height. Styles should be used to specify
* cell height when possible because the height attribute is deprecated in HTML 4.0.
*/
@Property(name = "height", displayName = "Height", category = "Layout",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String height = null;
/**
* Use the noWrap attribute to disable word wrapping of this column's
* cells in visual browsers. Word wrap can cause unnecessary horizontal scrolling
* when the browser window is small in relation to the font size. Styles
* should be used to disable word wrap when possible because the nowrap attribute
* is deprecated in HTML 4.0.
*/
@Property(name = "noWrap", displayName = "Suppress Word Wrap", category = "Appearance")
private boolean noWrap = false;
private boolean noWrap_set = false;
/**
* Scripting code executed when a mouse click
* occurs over this component.
*/
@Property(name = "onClick", displayName = "Click Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onClick = null;
/**
* Scripting code executed when a mouse double click
* occurs over this component.
*/
@Property(name = "onDblClick", displayName = "Double Click Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onDblClick = null;
/**
* Scripting code executed when the user presses down on a key while the
* component has focus.
*/
@Property(name = "onKeyDown", displayName = "Key Down Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onKeyDown = null;
/**
* Scripting code executed when the user presses and releases a key while
* the component has focus.
*/
@Property(name = "onKeyPress", displayName = "Key Press Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onKeyPress = null;
/**
* Scripting code executed when the user releases a key while the
* component has focus.
*/
@Property(name = "onKeyUp", displayName = "Key Up Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onKeyUp = null;
/**
* Scripting code executed when the user presses a mouse button while the
* mouse pointer is on the component.
*/
@Property(name = "onMouseDown", displayName = "Mouse Down Script",
category = "Javascript", editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onMouseDown = null;
/**
* Scripting code executed when the user moves the mouse pointer while
* over the component.
*/
@Property(name = "onMouseMove", displayName = "Mouse Move Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onMouseMove = null;
/**
* Scripting code executed when a mouse out movement
* occurs over this component.
*/
@Property(name = "onMouseOut", displayName = "Mouse Out Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onMouseOut = null;
/**
* Scripting code executed when the user moves the mouse pointer into
* the boundary of this component.
*/
@Property(name = "onMouseOver", displayName = "Mouse In Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onMouseOver = null;
/**
* Scripting code executed when the user releases a mouse button while
* the mouse pointer is on the component.
*/
@Property(name = "onMouseUp", displayName = "Mouse Up Script", category = "Javascript",
editorClassName = "com.sun.rave.propertyeditors.JavaScriptPropertyEditor")
private String onMouseUp = null;
/**
* Use the rowHeader attribute to specify that the cells of the
* column are acting as row headers. Row headers are cells that "label" the row.
* For example, consider a table where the first column contains checkboxes, and
* the second column contains user names. The third and subsequent columns contain
* attributes of those users. The content of the cells in the user name column are
* acting as row headers. The webuijsf:tableColumn tag for the user name
* column should set the rowHeader attribute to true. If a table
* contains, for example, a system log with time stamp and log entry columns,
* neither column is acting as a row header, so the rowHeader
* attribute should not be set.
*
* By default, most column cells are rendered by the table component with HTML
* <td scope="col"> elements. The exceptions are columns that
* contain checkboxes or radio buttons and spacer columns, all of which are
* rendered as <td> elements without a scope property.
*
* When you set the rowHeader attribute, the column cells are
* rendered as <th scope="row"> elements, which enables
* adaptive technologies such as screen readers to properly read the table to
* indicate that the contents of these cells are headers for the rows.
*/
@Property(name = "rowHeader", displayName = "Row Header", category = "Advanced")
private boolean rowHeader = false;
private boolean rowHeader_set = false;
/**
* The ROWSPAN attribute of TD specifies the number of rows that are
* spanned by the cell. The default value is 1. The special value 0
* indicates that the cell spans all rows to the end of the table. The
* value 0 is ignored by most browsers, so authors may wish to calculate
* the exact number of rows or columns spanned and use that value.
*/
@Property(name = "rowSpan", displayName = "Rows Spanned By the Cell", category = "Layout",
editorClassName = "com.sun.rave.propertyeditors.IntegerPropertyEditor", isAttribute = false)
private int rowSpan = Integer.MIN_VALUE;
private boolean rowSpan_set = false;
/**
* Use the scope attribute to specify that the data cells of the
* column are also acting as headers for rows or other columns of the table.
* This attribute supports assistive technologies by enabling them to determine
* the order in which to read the cells. Valid values include:
*
* row, when the cells provide header information for the rowcol, when the cells provide header information for the columnrowgroup, when the cells provide header information for the row groupcolgroup, when the cells provide header information for the column group
*/
@Property(name = "scope", displayName = "Cells Covered By Header Cell", category = "Advanced",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String scope = null;
/**
* Use the selectId attribute in select columns, which contain
* checkboxes or radio buttons for selecting table rows. The value of
* selectId must match the id attribute of the checkbox
* or radioButton component that is a child of the tableColumn component. A fully
* qualified ID based on the tableColumn component ID and the
* selectId for the current row will be dynamically created for the
* <input> element that is rendered for the checkbox or radio
* button. The selectId is required for functionality that supports
* the toggle buttons for selecting rows. The selectId also
* identifies the column as a select column, for which the table component
* uses different CSS styles.
*/
@Property(name = "selectId", displayName = "Select Component Id", category = "Data",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String selectId = null;
/**
* Use the severity attribute when including the webuijsf:alarm
* component in a column, to match the severity of the alarm. Valid values are
* described in the webuijsf:alarm documentation. When the
* severity attribute is set in the tableColumn, the table
* component renders sort tool tips to indicate that the column will be sorted
* least/most severe first, and the table cell appears hightlighted according to
* the level of severity. This functionality is overridden by the
* emptyCell attribute.
*/
@Property(name = "severity", displayName = "Severity", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String severity = null;
/**
* Use the sort attribute to specify a FieldKey id or SortCriteria
* that defines the criteria to use for sorting the contents of a
* TableDataProvider. If SortCriteria is provided, the object is used for sorting
* as is. If an id is provided, a FieldIdSortCriteria is created for sorting. In
* addition, a value binding can also be used to sort on an object that is
* external to TableDataProvider, such as the selected state of a checkbox or
* radiobutton. When a value binding is used, a ValueBindingSortCriteria object
* is created for sorting. All sorting is based on the object type associated with
* the data element (for example, Boolean, Character, Comparator, Date, Number,
* and String). If the object type cannot be determined, the object is compared as
* a String. The sort attribute is required for a column to be shown
* as sortable.
*/
@Property(name = "sort", displayName = "Sort Key", category = "Data",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private Object sort = null;
/**
* The theme identifier to use for the sort button that is displayed in the column
* header. Use this attribute to override the default image.
*/
@Property(name = "sortIcon", displayName = "Sort Icon", category = "Appearance",
editorClassName = "com.sun.webui.jsf.component.propertyeditors.ThemeIconsEditor")
private String sortIcon = null;
/**
* Absolute or relative URL to the image used for the sort button that is
* displayed in the column header.
*/
@Property(name = "sortImageURL", displayName = "Sort Image URL", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.ImageUrlPropertyEditor")
private String sortImageURL = null;
/**
* Use the spacerColumn attribute to use the column as a blank column
* to enhance spacing in two or three column tables. When the
* spacerColumn attribute is true, the CSS styles applied to the
* column make it appear as if the columns are justified. If a column header and
* footer are required, provide an empty string for the headerText
* and footerText attributes. Set the width attribute to
* justify columns accordingly.
*/
@Property(name = "spacerColumn", displayName = "Spacer Column", category = "Layout")
private boolean spacerColumn = false;
private boolean spacerColumn_set = false;
/**
* CSS style(s) to be applied to the outermost HTML element when this
* component is rendered.
*/
@Property(name = "style", displayName = "CSS Style(s)", category = "Appearance",
editorClassName = "com.sun.jsfcl.std.css.CssStylePropertyEditor")
private String style = null;
/**
* CSS style class(es) to be applied to the outermost HTML element when this
* component is rendered.
*/
@Property(name = "styleClass", displayName = "CSS Style Class(es)", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.StyleClassPropertyEditor")
private String styleClass = null;
/**
* The text to be displayed in the table column footer. The table column footer is
* displayed once per table, and is especially useful in tables with multiple
* groups of rows.
*/
@Property(name = "tableFooterText", displayName = "Table Footer Text", category = "Appearance",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String tableFooterText = null;
/**
* Sets the value of the title attribute for the HTML element.
* The specified text will display as a tooltip if the mouse cursor hovers
* over the HTML element.
*/
@Property(name = "toolTip", displayName = "Tool Tip", category = "Behavior",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String toolTip = null;
/**
* Use the valign attribute to specify the vertical alignment for the
* content of each cell in the column. Valid values are top,
* middle, bottom, and baseline. The
* default vertical alignment is middle. Setting the
* valign attribute to baseline causes the first line of
* each cell's content to be aligned on the text baseline, the invisible line on
* which text characters rest.
*/
@Property(name = "valign", displayName = "Vertical Position", category = "Appearance",
editorClassName = "com.sun.webui.jsf.component.propertyeditors.HtmlVerticalAlignEditor")
private String valign = null;
/**
* Use the visible attribute to indicate whether the component should be
* viewable by the user in the rendered HTML page. If set to false, the
* HTML code for the component is present in the page, but the component
* is hidden with style attributes. By default, visible is set to true, so
* HTML for the component HTML is included and visible to the user. If the
* component is not visible, it can still be processed on subsequent form
* submissions because the HTML is present.
*/
@Property(name = "visible", displayName = "Visible", category = "Behavior")
private boolean visible = false;
private boolean visible_set = false;
/**
* Use the width attribute to specify the width of the cells of the
* column. The width can be specified as the number of pixels or the percentage of
* the table width, and is especially useful for spacer columns. This attribute is
* deprecated in HTML 4.0 in favor of style sheets.
*/
@Property(name = "width", displayName = "Width", category = "Layout",
editorClassName = "com.sun.rave.propertyeditors.StringPropertyEditor")
private String width = null;
/** Default constructor */
public TableColumn() {
super();
setRendererType("com.sun.webui.jsf.TableColumn");
}
/**
* Return the family for this component.
*/
public String getFamily() {
return "com.sun.webui.jsf.TableColumn";
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Child methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Clear cached properties.
*
* 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. For example, the underlying DataProvider may have changed
* and TableRenderer may need new calculations for the title and action bar.
*
* Note: Properties of nested TableColumn children shall be cleared as well.
*
*/
public void clear() {
tableAncestor = null;
tableColumnAncestor = null;
tableColumnChildren = null;
tableRowGroupAncestor = null;
columnCount = -1;
rowCount = -1;
// Clear properties of nested TableColumn children.
Iterator kids = getTableColumnChildren();
while (kids.hasNext()) {
TableColumn kid = (TableColumn) kids.next();
kid.clear(); // Clear cached properties.
}
}
/**
* Get the closest Table ancestor that encloses this component.
*
* @return The Table ancestor.
*/
public Table getTableAncestor() {
if (tableAncestor == null) {
UIComponent component = this;
while (component != null) {
component = component.getParent();
if (component instanceof Table) {
tableAncestor = (Table) component;
break;
}
}
}
return tableAncestor;
}
/**
* Get the closest TableColumn ancestor that encloses this component.
*
* @return The TableColumn ancestor.
*/
public TableColumn getTableColumnAncestor() {
// Get TableColumn ancestor.
if (tableColumnAncestor == null) {
UIComponent component = this;
while (component != null) {
component = component.getParent();
if (component instanceof TableColumn) {
tableColumnAncestor = (TableColumn) component;
break;
}
}
}
return tableColumnAncestor;
}
/**
* Get an Iterator over the TableColumn children found for
* this component.
*
* @return An Iterator over the TableColumn children.
*/
public Iterator getTableColumnChildren() {
// Get TableColumn children.
if (tableColumnChildren == null) {
tableColumnChildren = new ArrayList();
Iterator kids = getChildren().iterator();
while (kids.hasNext()) {
UIComponent kid = (UIComponent) kids.next();
if ((kid instanceof TableColumn)) {
tableColumnChildren.add(kid);
}
}
}
return tableColumnChildren.iterator();
}
/**
* Get the number of columns found for this component that have a rendered
* property of true.
*
* @return The number of rendered columns.
*/
public int getColumnCount() {
// Get column count.
if (columnCount == -1) {
columnCount = getColumnCount(this);
}
return columnCount;
}
/**
* Get the closest TableRowGroup ancestor that encloses this component.
*
* @return The TableRowGroup ancestor.
*/
public TableRowGroup getTableRowGroupAncestor() {
// Get TableRowGroup ancestor.
if (tableRowGroupAncestor == null) {
UIComponent component = this;
while (component != null) {
component = component.getParent();
if (component instanceof TableRowGroup) {
tableRowGroupAncestor = (TableRowGroup) component;
break;
}
}
}
return tableRowGroupAncestor;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Column methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Get the horizontal alignment for the cell.
*
* 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.
*
* @return The horizontal alignment for the cell. If the align property is
* null or the object type cannot be determined, "left" is returned by
* default.
*/
public String getAlign() {
// Note: The align property overrides alignKey.
if (_getAlign() != null) {
return _getAlign();
}
// Get alignment.
String result = null;
Class type = getType();
if (type != null && (Character.class.isAssignableFrom(type) || String.class.isAssignableFrom(type))) {
result = "left"; //NOI18N
} else if (type != null && (Date.class.isAssignableFrom(type) || Number.class.isAssignableFrom(type))) {
result = "right"; //NOI18N
} else if (type != null && Boolean.class.isAssignableFrom(type)) {
result = "center"; //NOI18N
} else {
// Note: Select columns also default to "left".
result = "left"; //NOI18N
}
return result;
}
/**
* Get column footer.
*
* @return The column footer.
*/
public UIComponent getColumnFooter() {
UIComponent facet = getFacet(COLUMN_FOOTER_FACET);
if (facet != null) {
return facet;
}
// Get child.
TableFooter child = new TableFooter();
child.setId(COLUMN_FOOTER_ID);
child.setAlign(getAlign());
child.setExtraHtml(getExtraFooterHtml());
child.setVisible(isVisible());
// Set rendered.
if (!(facet != null && facet.isRendered() || isColumnFooterRendered())) {
// Note: Footer may be initialized to force rendering. This allows
// developers to omit the footerText property for select columns.
child.setRendered(false);
} else {
log("getColumnFooter", //NOI18N
"Column footer not rendered, nothing to display"); //NOI18N
}
// If only showing one level, don't set colspan or rowspan.
TableRowGroup group = getTableRowGroupAncestor();
if (group != null && group.isMultipleColumnFooters()) {
// Set colspan for nested TableColumn children, else rowspan.
Iterator kids = getTableColumnChildren();
if (kids.hasNext()) {
int colspan = getColumnCount();
if (colspan > 1) {
child.setColSpan(colspan);
}
} else {
int rowspan = getRowCount();
if (rowspan > 1) {
child.setRowSpan(rowspan);
}
}
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
/**
* Get column header.
*
* @return The column header.
*/
public UIComponent getColumnHeader() {
UIComponent facet = getFacet(COLUMN_HEADER_FACET);
if (facet != null) {
return facet;
}
// Get child.
TableHeader child = new TableHeader();
child.setId(COLUMN_HEADER_ID);
child.setScope("col"); //NOI18N
child.setAlign(getAlign());
child.setWidth((getSelectId() != null) ? "3%" : null); //NOI18N
child.setNoWrap((getSelectId() != null) ? true : false);
child.setExtraHtml(getExtraHeaderHtml());
child.setVisible(isVisible());
// Set type of header to render.
boolean emptyTable = isEmptyTable();
SortCriteria criteria = getSortCriteria();
if (criteria != null && getSelectId() != null && !emptyTable) {
child.setSelectHeader(true);
} else if (criteria != null && getHeaderText() != null && !emptyTable) {
child.setSortHeader(true);
} else {
log("getColumnHeader", //NOI18N
"Render default column header, no SortCriteria or selectId"); //NOI18N
}
// Set rendered.
if (!(facet != null && facet.isRendered() || isColumnHeaderRendered())) {
// Note: Footer may be initialized to force rendering. This allows
// developers to omit the headerText property for select columns.
log("getColumnHeader", //NOI18N
"Column header not rendered, nothing to display"); //NOI18N
child.setRendered(false);
}
// Set colspan for nested TableColumn children, else rowspan.
Iterator kids = getTableColumnChildren();
if (kids.hasNext()) {
int colspan = getColumnCount();
if (colspan > 1) {
child.setColSpan(colspan);
}
} else {
int rowspan = getRowCount();
if (rowspan > 1) {
child.setRowSpan(rowspan);
}
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
/**
* Get table column footer.
*
* @return The table column footer.
*/
public UIComponent getTableColumnFooter() {
UIComponent facet = getFacet(TABLE_COLUMN_FOOTER_FACET);
if (facet != null) {
return facet;
}
// Get child.
TableFooter child = new TableFooter();
child.setId(TABLE_COLUMN_FOOTER_ID);
child.setAlign(getAlign());
child.setExtraHtml(getExtraTableFooterHtml());
child.setTableColumnFooter(true);
child.setVisible(isVisible());
// Set rendered.
if (!(facet != null && facet.isRendered() || isTableColumnFooterRendered())) {
// Note: Footer may be initialized to force rendering. This allows
// developers to omit the tableFooterText property for select columns.
child.setRendered(false);
} else {
log("getTableColumnFooter", //NOI18N
"Table column footer not rendered, nothing to display"); //NOI18N
}
// If only showing one level, don't set colspan or rowspan.
TableRowGroup group = getTableRowGroupAncestor();
if (group != null && group.isMultipleTableColumnFooters()) {
// Set colspan for nested TableColumn children, else rowspan.
Iterator kids = getTableColumnChildren();
if (kids.hasNext()) {
int colspan = getColumnCount();
if (colspan > 1) {
child.setColSpan(colspan);
}
} else {
int rowspan = getRowCount();
if (rowspan > 1) {
child.setRowSpan(rowspan);
}
}
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Empty cell methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Get the icon used to display inapplicable or unexpectedly empty cells.
*
* 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.
*
* @return The icon used to display empty cells.
*/
public UIComponent getEmptyCellIcon() {
UIComponent facet = getFacet(EMPTY_CELL_ICON_FACET);
if (facet != null) {
return facet;
}
Theme theme = getTheme();
// Get child.
Icon child = ThemeUtilities.getIcon(theme,
ThemeImages.TABLE_EMPTY_CELL);
child.setId(EMPTY_CELL_ICON_ID);
child.setBorder(0);
// Set tool tip.
String toolTip = theme.getMessage("table.emptyTableCell"); //NOI18N
child.setToolTip(toolTip);
child.setAlt(toolTip);
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Separator methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Get separator icon for embedded actions.
*
* @return The separator icon for embedded actions.
*/
public UIComponent getEmbeddedActionSeparatorIcon() {
UIComponent facet = getFacet(EMBEDDED_ACTION_SEPARATOR_ICON_FACET);
if (facet != null) {
return facet;
}
// Get child.
Icon child = ThemeUtilities.getIcon(getTheme(),
ThemeImages.TABLE_EMBEDDED_ACTIONS_SEPARATOR);
child.setId(EMBEDDED_ACTION_SEPARATOR_ICON_ID);
child.setBorder(0);
child.setAlign("top"); //NOI18N
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Sort methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Get SortCriteria used for sorting the contents of a TableDataProvider.
*
* 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.
*
* @return The SortCriteria used for sorting.
*/
public SortCriteria getSortCriteria() {
// Return if value binding resolves to a SortCriteria object.
Object key = getSort();
if (key instanceof SortCriteria) {
return (SortCriteria) key;
}
SortCriteria result = null;
ValueExpression vb = getValueExpression("sort"); //NOI18N
if (vb != null) {
ValueBindingSortCriteria vbsc = new ValueBindingSortCriteria(vb,
!isDescending()); // Note: Constructor accepts ascending param.
TableRowGroup group = getTableRowGroupAncestor();
if (group != null) {
vbsc.setRequestMapKey(group.getSourceVar());
}
result = vbsc;
} else if (key != null) {
result = new FieldIdSortCriteria(key.toString(), !isDescending());
}
return result;
}
/**
* Get sort tool tip augment based on the value given to the align
* property of the tableColumn component.
*
* @param descending Flag indicating descending sort.
* @return The sort tool tip augment.
*/
public String getSortToolTipAugment(boolean descending) {
String result = null;
// To do: Test for toolTip property? The alarm or other custom
// components may need to set the tooltip. If so, do we need both
// ascending and descending tooltips?
// Get object type.
Class type = getType();
// Get tooltip.
ValueExpression vb = getValueExpression("severity"); //NOI18N
if (getSeverity() != null || vb != null) {
result = (descending)
? "table.sort.augment.alarmDescending" //NOI18N
: "table.sort.augment.alarmAscending"; //NOI18N
} else if (getSelectId() != null || (type != null && type.equals(Boolean.class))) {
result = (descending)
? "table.sort.augment.booleanDescending" //NOI18N
: "table.sort.augment.booleanAscending"; //NOI18N
} else if (type != null && type.equals(String.class)) {
result = (descending)
? "table.sort.augment.stringDescending" //NOI18N
: "table.sort.augment.stringAscending"; //NOI18N
} else if (type != null && type.equals(Character.class)) {
result = (descending)
? "table.sort.augment.charDescending" //NOI18N
: "table.sort.augment.charAscending"; //NOI18N
} else if (type != null && type.equals(Date.class)) {
result = (descending)
? "table.sort.augment.dateDescending" //NOI18N
: "table.sort.augment.dateAscending"; //NOI18N
} else if (type != null && type.equals(Number.class)) {
result = (descending)
? "table.sort.augment.numericDescending" //NOI18N
: "table.sort.augment.numericAscending"; //NOI18N
} else {
result = (descending)
? "table.sort.augment.undeterminedDescending" //NOI18N
: "table.sort.augment.undeterminedAscending"; //NOI18N
}
return getTheme().getMessage(result);
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Tag attribute methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* The component identifier for this component. This value must be unique
* within the closest parent component that is a naming container.
*/
@Property(name = "id")
@Override
public void setId(String id) {
super.setId(id);
}
/**
* Use the rendered attribute to indicate whether the HTML code for the
* component should be included in the rendered HTML page. If set to false,
* the rendered HTML page does not include the HTML for the component. If
* the component is not rendered, it is also not processed on any subsequent
* form submission.
*/
@Property(name = "rendered")
@Override
public void setRendered(boolean rendered) {
super.setRendered(rendered);
}
/**
* ABBR gives an abbreviated version of the cell's content. This allows
* visual browsers to use the short form if space is limited, and
* non-visual browsers can give a cell's header information in an
* abbreviated form before rendering each cell.
*/
public String getAbbr() {
if (this.abbr != null) {
return this.abbr;
}
ValueExpression _vb = getValueExpression("abbr");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* ABBR gives an abbreviated version of the cell's content. This allows
* visual browsers to use the short form if space is limited, and
* non-visual browsers can give a cell's header information in an
* abbreviated form before rendering each cell.
*/
public void setAbbr(String abbr) {
this.abbr = abbr;
}
/**
* Use the align attribute to specify the horizontal alignment for
* the content of each cell in the column. Valid values are left,
* center, right, justify, and
* char. The default alignment is left. Setting the
* align attribute to char causes the cell's contents
* to be aligned on the character that you specify with the char
* attribute. For example, to align cell contents on colons, set
* align="char" and char=":" Some browsers do not
* support aligning on the character.
*/
private String _getAlign() { // FIX: Merge gen code with method of same name
if (this.align != null) {
return this.align;
}
ValueExpression _vb = getValueExpression("align");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use the align attribute to specify the horizontal alignment for
* the content of each cell in the column. Valid values are left,
* center, right, justify, and
* char. The default alignment is left. Setting the
* align attribute to char causes the cell's contents
* to be aligned on the character that you specify with the char
* attribute. For example, to align cell contents on colons, set
* align="char" and char=":" Some browsers do not
* support aligning on the character.
*/
public void setAlign(String align) {
this.align = align;
}
/**
* Use the alignKey attribute to specify the FieldKey id or FieldKey
* to be used as an identifier for a specific data element on which to align the
* table cell data in the column. If alignKey specifies a
* FieldKey, the FieldKey is used as is; otherwise, a FieldKey is created using
* the alignKey value that you specify. Alignment is based on
* the object type of the data element. For example, Date and Number objects are
* aligned "right", Character and String objects are aligned "left", and Boolean
* objects are aligned "center". All columns, including select columns, are
* aligned "left" by default. Note that the align property overrides this value.
*/
public Object getAlignKey() {
if (this.alignKey != null) {
return this.alignKey;
}
ValueExpression _vb = getValueExpression("alignKey");
if (_vb != null) {
return (Object) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use the alignKey attribute to specify the FieldKey id or FieldKey
* to be used as an identifier for a specific data element on which to align the
* table cell data in the column. If alignKey specifies a
* FieldKey, the FieldKey is used as is; otherwise, a FieldKey is created using
* the alignKey value that you specify. Alignment is based on
* the object type of the data element. For example, Date and Number objects are
* aligned "right", Character and String objects are aligned "left", and Boolean
* objects are aligned "center". All columns, including select columns, are
* aligned "left" by default. Note that the align property overrides this value.
*/
public void setAlignKey(Object alignKey) {
this.alignKey = alignKey;
}
/**
* The AXIS attribute provides a method of categorizing cells. The
* attribute's value is a comma-separated list of category names. See the
* HTML 4.0 Recommendation's section on categorizing cells for an
* application of AXIS.
*/
public String getAxis() {
if (this.axis != null) {
return this.axis;
}
ValueExpression _vb = getValueExpression("axis");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The AXIS attribute provides a method of categorizing cells. The
* attribute's value is a comma-separated list of category names. See the
* HTML 4.0 Recommendation's section on categorizing cells for an
* application of AXIS.
*/
public void setAxis(String axis) {
this.axis = axis;
}
/**
* The BGCOLOR attribute suggests a background color for the cell. The
* combination of this attribute with can leave
* invisible or unreadable text on Netscape Navigator 2.x, which does not
* support BGCOLOR on table elements. BGCOLOR is dangerous even on
* supporting browsers, since most fail to override it when overriding
* other author-specified colors. Style sheets provide a safer, more
* flexible method of specifying a table's background color. This
* attribute is deprecated (in HTML 4.0) in favor of style sheets.
*/
public String getBgColor() {
if (this.bgColor != null) {
return this.bgColor;
}
ValueExpression _vb = getValueExpression("bgColor");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The BGCOLOR attribute suggests a background color for the cell. The
* combination of this attribute with can leave
* invisible or unreadable text on Netscape Navigator 2.x, which does not
* support BGCOLOR on table elements. BGCOLOR is dangerous even on
* supporting browsers, since most fail to override it when overriding
* other author-specified colors. Style sheets provide a safer, more
* flexible method of specifying a table's background color. This
* attribute is deprecated (in HTML 4.0) in favor of style sheets.
*/
public void setBgColor(String bgColor) {
this.bgColor = bgColor;
}
/**
* Use the char attribute to specify a character to use for
* horizontal alignment in each cell in the row. You must also set the
* align attribute to char to enable character alignment
* to be used. The default value for the char attribute is the
* decimal point of the current language, such as a period in English. The
* char HTML property is not supported by all browsers.
*/
public String getChar() {
if (this._char != null) {
return this._char;
}
ValueExpression _vb = getValueExpression("char");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use the char attribute to specify a character to use for
* horizontal alignment in each cell in the row. You must also set the
* align attribute to char to enable character alignment
* to be used. The default value for the char attribute is the
* decimal point of the current language, such as a period in English. The
* char HTML property is not supported by all browsers.
*/
public void setChar(String _char) {
this._char = _char;
}
/**
* Use the charOff attribute to specify the offset of the first
* occurrence of the alignment character that is specified with the
* char attribute. The offset is the distance from the left cell
* border, in locales that read from left to right. The charOff
* attribute's value can be a number of pixels or a percentage of the cell's
* width. For example, charOff="50%" centers the alignment character
* horizontally in a cell. If charOff="25%", the first instance
* of the alignment character is placed at one fourth of the width of the cell.
*/
public String getCharOff() {
if (this.charOff != null) {
return this.charOff;
}
ValueExpression _vb = getValueExpression("charOff");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use the charOff attribute to specify the offset of the first
* occurrence of the alignment character that is specified with the
* char attribute. The offset is the distance from the left cell
* border, in locales that read from left to right. The charOff
* attribute's value can be a number of pixels or a percentage of the cell's
* width. For example, charOff="50%" centers the alignment character
* horizontally in a cell. If charOff="25%", the first instance
* of the alignment character is placed at one fourth of the width of the cell.
*/
public void setCharOff(String charOff) {
this.charOff = charOff;
}
/**
* The COLSPAN attribute of TD specifies the number of columns that are
* spanned by the cell. The default value is 1. The special value 0
* indicates that the cell spans all columns to the end of the table. The
* value 0 is ignored by most browsers, so authors may wish to calculate
* the exact number of rows or columns spanned and use that value.
*/
public int getColSpan() {
if (this.colSpan_set) {
return this.colSpan;
}
ValueExpression _vb = getValueExpression("colSpan");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return Integer.MIN_VALUE;
} else {
return ((Integer) _result).intValue();
}
}
return Integer.MIN_VALUE;
}
/**
* The COLSPAN attribute of TD specifies the number of columns that are
* spanned by the cell. The default value is 1. The special value 0
* indicates that the cell spans all columns to the end of the table. The
* value 0 is ignored by most browsers, so authors may wish to calculate
* the exact number of rows or columns spanned and use that value.
*/
public void setColSpan(int colSpan) {
this.colSpan = colSpan;
this.colSpan_set = true;
}
/**
* Use the descending attribute to specify that the first
* user-applied sort is descending. By default, the first time a user clicks a
* column's sort button or column header, the sort is ascending. Note that this
* not an initial sort. The data is initially displayed unsorted.
*/
public boolean isDescending() {
if (this.descending_set) {
return this.descending;
}
ValueExpression _vb = getValueExpression("descending");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Use the descending attribute to specify that the first
* user-applied sort is descending. By default, the first time a user clicks a
* column's sort button or column header, the sort is ascending. Note that this
* not an initial sort. The data is initially displayed unsorted.
*/
public void setDescending(boolean descending) {
this.descending = descending;
this.descending_set = true;
}
/**
* Set the embeddedActions attribute to true when the column includes
* more than one embedded action. This attribute causes a separator image to be
* displayed between the action links. This attribute is overridden by the
* emptyCell attribute.
*/
public boolean isEmbeddedActions() {
if (this.embeddedActions_set) {
return this.embeddedActions;
}
ValueExpression _vb = getValueExpression("embeddedActions");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Set the embeddedActions attribute to true when the column includes
* more than one embedded action. This attribute causes a separator image to be
* displayed between the action links. This attribute is overridden by the
* emptyCell attribute.
*/
public void setEmbeddedActions(boolean embeddedActions) {
this.embeddedActions = embeddedActions;
this.embeddedActions_set = true;
}
/**
* Use the emptyCell attribute to cause a theme-specific image to be
* displayed when the content of a table cell is not applicable or is unexpectedly
* empty. You should not use this attribute for a value that is truly null, such
* as an empty alarm cell or a comment field that is blank. In addition, the image
* should not be used for cells that contain user interface elements such as
* checkboxes or drop-down lists when these elements are not applicable. Instead,
* the elements should simply not be displayed so the cell is left empty.
*/
public boolean isEmptyCell() {
if (this.emptyCell_set) {
return this.emptyCell;
}
ValueExpression _vb = getValueExpression("emptyCell");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Use the emptyCell attribute to cause a theme-specific image to be
* displayed when the content of a table cell is not applicable or is unexpectedly
* empty. You should not use this attribute for a value that is truly null, such
* as an empty alarm cell or a comment field that is blank. In addition, the image
* should not be used for cells that contain user interface elements such as
* checkboxes or drop-down lists when these elements are not applicable. Instead,
* the elements should simply not be displayed so the cell is left empty.
*/
public void setEmptyCell(boolean emptyCell) {
this.emptyCell = emptyCell;
this.emptyCell_set = true;
}
/**
* Extra HTML code to be appended to the <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 String getExtraFooterHtml() {
if (this.extraFooterHtml != null) {
return this.extraFooterHtml;
}
ValueExpression _vb = getValueExpression("extraFooterHtml");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Extra HTML code to be appended to the <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(String extraFooterHtml) {
this.extraFooterHtml = extraFooterHtml;
}
/**
* Extra HTML code to be appended to the <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 String getExtraHeaderHtml() {
if (this.extraHeaderHtml != null) {
return this.extraHeaderHtml;
}
ValueExpression _vb = getValueExpression("extraHeaderHtml");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Extra HTML code to be appended to the <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(String extraHeaderHtml) {
this.extraHeaderHtml = extraHeaderHtml;
}
/**
* Extra HTML code to be appended to the <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 String getExtraTableFooterHtml() {
if (this.extraTableFooterHtml != null) {
return this.extraTableFooterHtml;
}
ValueExpression _vb = getValueExpression("extraTableFooterHtml");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Extra HTML code to be appended to the <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(String extraTableFooterHtml) {
this.extraTableFooterHtml = extraTableFooterHtml;
}
/**
* The text to be displayed in the column footer.
*/
public String getFooterText() {
if (this.footerText != null) {
return this.footerText;
}
ValueExpression _vb = getValueExpression("footerText");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The text to be displayed in the column footer.
*/
public void setFooterText(String footerText) {
this.footerText = footerText;
}
/**
* The text to be displayed in the column header.
*/
public String getHeaderText() {
if (this.headerText != null) {
return this.headerText;
}
ValueExpression _vb = getValueExpression("headerText");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The text to be displayed in the column header.
*/
public void setHeaderText(String headerText) {
this.headerText = headerText;
}
/**
* The HEADERS attribute specifies the header cells that apply to the
* TD. The value is a space-separated list of the header cells' ID
* attribute values. The HEADERS attribute allows non-visual browsers to
* render the header information for a given cell.
*/
public String getHeaders() {
if (this.headers != null) {
return this.headers;
}
ValueExpression _vb = getValueExpression("headers");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The HEADERS attribute specifies the header cells that apply to the
* TD. The value is a space-separated list of the header cells' ID
* attribute values. The HEADERS attribute allows non-visual browsers to
* render the header information for a given cell.
*/
public void setHeaders(String headers) {
this.headers = headers;
}
/**
* The number of pixels for the cell's height. Styles should be used to specify
* cell height when possible because the height attribute is deprecated in HTML 4.0.
*/
public String getHeight() {
if (this.height != null) {
return this.height;
}
ValueExpression _vb = getValueExpression("height");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The number of pixels for the cell's height. Styles should be used to specify
* cell height when possible because the height attribute is deprecated in HTML 4.0.
*/
public void setHeight(String height) {
this.height = height;
}
/**
* Use the noWrap attribute to disable word wrapping of this column's
* cells in visual browsers. Word wrap can cause unnecessary horizontal scrolling
* when the browser window is small in relation to the font size. Styles
* should be used to disable word wrap when possible because the nowrap attribute
* is deprecated in HTML 4.0.
*/
public boolean isNoWrap() {
if (this.noWrap_set) {
return this.noWrap;
}
ValueExpression _vb = getValueExpression("noWrap");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Use the noWrap attribute to disable word wrapping of this column's
* cells in visual browsers. Word wrap can cause unnecessary horizontal scrolling
* when the browser window is small in relation to the font size. Styles
* should be used to disable word wrap when possible because the nowrap attribute
* is deprecated in HTML 4.0.
*/
public void setNoWrap(boolean noWrap) {
this.noWrap = noWrap;
this.noWrap_set = true;
}
/**
* Scripting code executed when a mouse click
* occurs over this component.
*/
public String getOnClick() {
if (this.onClick != null) {
return this.onClick;
}
ValueExpression _vb = getValueExpression("onClick");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when a mouse click
* occurs over this component.
*/
public void setOnClick(String onClick) {
this.onClick = onClick;
}
/**
* Scripting code executed when a mouse double click
* occurs over this component.
*/
public String getOnDblClick() {
if (this.onDblClick != null) {
return this.onDblClick;
}
ValueExpression _vb = getValueExpression("onDblClick");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when a mouse double click
* occurs over this component.
*/
public void setOnDblClick(String onDblClick) {
this.onDblClick = onDblClick;
}
/**
* Scripting code executed when the user presses down on a key while the
* component has focus.
*/
public String getOnKeyDown() {
if (this.onKeyDown != null) {
return this.onKeyDown;
}
ValueExpression _vb = getValueExpression("onKeyDown");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user presses down on a key while the
* component has focus.
*/
public void setOnKeyDown(String onKeyDown) {
this.onKeyDown = onKeyDown;
}
/**
* Scripting code executed when the user presses and releases a key while
* the component has focus.
*/
public String getOnKeyPress() {
if (this.onKeyPress != null) {
return this.onKeyPress;
}
ValueExpression _vb = getValueExpression("onKeyPress");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user presses and releases a key while
* the component has focus.
*/
public void setOnKeyPress(String onKeyPress) {
this.onKeyPress = onKeyPress;
}
/**
* Scripting code executed when the user releases a key while the
* component has focus.
*/
public String getOnKeyUp() {
if (this.onKeyUp != null) {
return this.onKeyUp;
}
ValueExpression _vb = getValueExpression("onKeyUp");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user releases a key while the
* component has focus.
*/
public void setOnKeyUp(String onKeyUp) {
this.onKeyUp = onKeyUp;
}
/**
* Scripting code executed when the user presses a mouse button while the
* mouse pointer is on the component.
*/
public String getOnMouseDown() {
if (this.onMouseDown != null) {
return this.onMouseDown;
}
ValueExpression _vb = getValueExpression("onMouseDown");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user presses a mouse button while the
* mouse pointer is on the component.
*/
public void setOnMouseDown(String onMouseDown) {
this.onMouseDown = onMouseDown;
}
/**
* Scripting code executed when the user moves the mouse pointer while
* over the component.
*/
public String getOnMouseMove() {
if (this.onMouseMove != null) {
return this.onMouseMove;
}
ValueExpression _vb = getValueExpression("onMouseMove");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user moves the mouse pointer while
* over the component.
*/
public void setOnMouseMove(String onMouseMove) {
this.onMouseMove = onMouseMove;
}
/**
* Scripting code executed when a mouse out movement
* occurs over this component.
*/
public String getOnMouseOut() {
if (this.onMouseOut != null) {
return this.onMouseOut;
}
ValueExpression _vb = getValueExpression("onMouseOut");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when a mouse out movement
* occurs over this component.
*/
public void setOnMouseOut(String onMouseOut) {
this.onMouseOut = onMouseOut;
}
/**
* Scripting code executed when the user moves the mouse pointer into
* the boundary of this component.
*/
public String getOnMouseOver() {
if (this.onMouseOver != null) {
return this.onMouseOver;
}
ValueExpression _vb = getValueExpression("onMouseOver");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user moves the mouse pointer into
* the boundary of this component.
*/
public void setOnMouseOver(String onMouseOver) {
this.onMouseOver = onMouseOver;
}
/**
* Scripting code executed when the user releases a mouse button while
* the mouse pointer is on the component.
*/
public String getOnMouseUp() {
if (this.onMouseUp != null) {
return this.onMouseUp;
}
ValueExpression _vb = getValueExpression("onMouseUp");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Scripting code executed when the user releases a mouse button while
* the mouse pointer is on the component.
*/
public void setOnMouseUp(String onMouseUp) {
this.onMouseUp = onMouseUp;
}
/**
* Use the rowHeader attribute to specify that the cells of the
* column are acting as row headers. Row headers are cells that "label" the row.
* For example, consider a table where the first column contains checkboxes, and
* the second column contains user names. The third and subsequent columns contain
* attributes of those users. The content of the cells in the user name column are
* acting as row headers. The webuijsf:tableColumn tag for the user name
* column should set the rowHeader attribute to true. If a table
* contains, for example, a system log with time stamp and log entry columns,
* neither column is acting as a row header, so the rowHeader
* attribute should not be set.
*
* By default, most column cells are rendered by the table component with HTML
* <td scope="col"> elements. The exceptions are columns that
* contain checkboxes or radio buttons and spacer columns, all of which are
* rendered as <td> elements without a scope property.
*
* When you set the rowHeader attribute, the column cells are
* rendered as <th scope="row"> elements, which enables
* adaptive technologies such as screen readers to properly read the table to
* indicate that the contents of these cells are headers for the rows.
*/
public boolean isRowHeader() {
if (this.rowHeader_set) {
return this.rowHeader;
}
ValueExpression _vb = getValueExpression("rowHeader");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Use the rowHeader attribute to specify that the cells of the
* column are acting as row headers. Row headers are cells that "label" the row.
* For example, consider a table where the first column contains checkboxes, and
* the second column contains user names. The third and subsequent columns contain
* attributes of those users. The content of the cells in the user name column are
* acting as row headers. The webuijsf:tableColumn tag for the user name
* column should set the rowHeader attribute to true. If a table
* contains, for example, a system log with time stamp and log entry columns,
* neither column is acting as a row header, so the rowHeader
* attribute should not be set.
*
* By default, most column cells are rendered by the table component with HTML
* <td scope="col"> elements. The exceptions are columns that
* contain checkboxes or radio buttons and spacer columns, all of which are
* rendered as <td> elements without a scope property.
*
* When you set the rowHeader attribute, the column cells are
* rendered as <th scope="row"> elements, which enables
* adaptive technologies such as screen readers to properly read the table to
* indicate that the contents of these cells are headers for the rows.
*/
public void setRowHeader(boolean rowHeader) {
this.rowHeader = rowHeader;
this.rowHeader_set = true;
}
/**
* The ROWSPAN attribute of TD specifies the number of rows that are
* spanned by the cell. The default value is 1. The special value 0
* indicates that the cell spans all rows to the end of the table. The
* value 0 is ignored by most browsers, so authors may wish to calculate
* the exact number of rows or columns spanned and use that value.
*/
public int getRowSpan() {
if (this.rowSpan_set) {
return this.rowSpan;
}
ValueExpression _vb = getValueExpression("rowSpan");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return Integer.MIN_VALUE;
} else {
return ((Integer) _result).intValue();
}
}
return Integer.MIN_VALUE;
}
/**
* The ROWSPAN attribute of TD specifies the number of rows that are
* spanned by the cell. The default value is 1. The special value 0
* indicates that the cell spans all rows to the end of the table. The
* value 0 is ignored by most browsers, so authors may wish to calculate
* the exact number of rows or columns spanned and use that value.
*/
public void setRowSpan(int rowSpan) {
this.rowSpan = rowSpan;
this.rowSpan_set = true;
}
/**
* Use the scope attribute to specify that the data cells of the
* column are also acting as headers for rows or other columns of the table.
* This attribute supports assistive technologies by enabling them to determine
* the order in which to read the cells. Valid values include:
*
* row, when the cells provide header information for the rowcol, when the cells provide header information for the columnrowgroup, when the cells provide header information for the row groupcolgroup, when the cells provide header information for the column group
*/
public String getScope() {
if (this.scope != null) {
return this.scope;
}
ValueExpression _vb = getValueExpression("scope");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use the scope attribute to specify that the data cells of the
* column are also acting as headers for rows or other columns of the table.
* This attribute supports assistive technologies by enabling them to determine
* the order in which to read the cells. Valid values include:
*
* row, when the cells provide header information for the rowcol, when the cells provide header information for the columnrowgroup, when the cells provide header information for the row groupcolgroup, when the cells provide header information for the column group
*/
public void setScope(String scope) {
this.scope = scope;
}
/**
* Use the selectId attribute in select columns, which contain
* checkboxes or radio buttons for selecting table rows. The value of
* selectId must match the id attribute of the checkbox
* or radioButton component that is a child of the tableColumn component. A fully
* qualified ID based on the tableColumn component ID and the
* selectId for the current row will be dynamically created for the
* <input> element that is rendered for the checkbox or radio
* button. The selectId is required for functionality that supports
* the toggle buttons for selecting rows. The selectId also
* identifies the column as a select column, for which the table component
* uses different CSS styles.
*/
public String getSelectId() {
if (this.selectId != null) {
return this.selectId;
}
ValueExpression _vb = getValueExpression("selectId");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use the selectId attribute in select columns, which contain
* checkboxes or radio buttons for selecting table rows. The value of
* selectId must match the id attribute of the checkbox
* or radioButton component that is a child of the tableColumn component. A fully
* qualified ID based on the tableColumn component ID and the
* selectId for the current row will be dynamically created for the
* <input> element that is rendered for the checkbox or radio
* button. The selectId is required for functionality that supports
* the toggle buttons for selecting rows. The selectId also
* identifies the column as a select column, for which the table component
* uses different CSS styles.
*/
public void setSelectId(String selectId) {
this.selectId = selectId;
}
/**
* Use the severity attribute when including the webuijsf:alarm
* component in a column, to match the severity of the alarm. Valid values are
* described in the webuijsf:alarm documentation. When the
* severity attribute is set in the tableColumn, the table
* component renders sort tool tips to indicate that the column will be sorted
* least/most severe first, and the table cell appears hightlighted according to
* the level of severity. This functionality is overridden by the
* emptyCell attribute.
*/
public String getSeverity() {
if (this.severity != null) {
return this.severity;
}
ValueExpression _vb = getValueExpression("severity");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use the severity attribute when including the webuijsf:alarm
* component in a column, to match the severity of the alarm. Valid values are
* described in the webuijsf:alarm documentation. When the
* severity attribute is set in the tableColumn, the table
* component renders sort tool tips to indicate that the column will be sorted
* least/most severe first, and the table cell appears hightlighted according to
* the level of severity. This functionality is overridden by the
* emptyCell attribute.
*/
public void setSeverity(String severity) {
this.severity = severity;
}
/**
* Use the sort attribute to specify a FieldKey id or SortCriteria
* that defines the criteria to use for sorting the contents of a
* TableDataProvider. If SortCriteria is provided, the object is used for sorting
* as is. If an id is provided, a FieldIdSortCriteria is created for sorting. In
* addition, a value binding can also be used to sort on an object that is
* external to TableDataProvider, such as the selected state of a checkbox or
* radiobutton. When a value binding is used, a ValueBindingSortCriteria object
* is created for sorting. All sorting is based on the object type associated with
* the data element (for example, Boolean, Character, Comparator, Date, Number,
* and String). If the object type cannot be determined, the object is compared as
* a String. The sort attribute is required for a column to be shown
* as sortable.
*/
public Object getSort() {
if (this.sort != null) {
return this.sort;
}
ValueExpression _vb = getValueExpression("sort");
if (_vb != null) {
return (Object) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use the sort attribute to specify a FieldKey id or SortCriteria
* that defines the criteria to use for sorting the contents of a
* TableDataProvider. If SortCriteria is provided, the object is used for sorting
* as is. If an id is provided, a FieldIdSortCriteria is created for sorting. In
* addition, a value binding can also be used to sort on an object that is
* external to TableDataProvider, such as the selected state of a checkbox or
* radiobutton. When a value binding is used, a ValueBindingSortCriteria object
* is created for sorting. All sorting is based on the object type associated with
* the data element (for example, Boolean, Character, Comparator, Date, Number,
* and String). If the object type cannot be determined, the object is compared as
* a String. The sort attribute is required for a column to be shown
* as sortable.
*/
public void setSort(Object sort) {
this.sort = sort;
}
/**
* The theme identifier to use for the sort button that is displayed in the column
* header. Use this attribute to override the default image.
*/
public String getSortIcon() {
if (this.sortIcon != null) {
return this.sortIcon;
}
ValueExpression _vb = getValueExpression("sortIcon");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The theme identifier to use for the sort button that is displayed in the column
* header. Use this attribute to override the default image.
*/
public void setSortIcon(String sortIcon) {
this.sortIcon = sortIcon;
}
/**
* Absolute or relative URL to the image used for the sort button that is
* displayed in the column header.
*/
public String getSortImageURL() {
if (this.sortImageURL != null) {
return this.sortImageURL;
}
ValueExpression _vb = getValueExpression("sortImageURL");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Absolute or relative URL to the image used for the sort button that is
* displayed in the column header.
*/
public void setSortImageURL(String sortImageURL) {
this.sortImageURL = sortImageURL;
}
/**
* Use the spacerColumn attribute to use the column as a blank column
* to enhance spacing in two or three column tables. When the
* spacerColumn attribute is true, the CSS styles applied to the
* column make it appear as if the columns are justified. If a column header and
* footer are required, provide an empty string for the headerText
* and footerText attributes. Set the width attribute to
* justify columns accordingly.
*/
public boolean isSpacerColumn() {
if (this.spacerColumn_set) {
return this.spacerColumn;
}
ValueExpression _vb = getValueExpression("spacerColumn");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Use the spacerColumn attribute to use the column as a blank column
* to enhance spacing in two or three column tables. When the
* spacerColumn attribute is true, the CSS styles applied to the
* column make it appear as if the columns are justified. If a column header and
* footer are required, provide an empty string for the headerText
* and footerText attributes. Set the width attribute to
* justify columns accordingly.
*/
public void setSpacerColumn(boolean spacerColumn) {
this.spacerColumn = spacerColumn;
this.spacerColumn_set = true;
}
/**
* CSS style(s) to be applied to the outermost HTML element when this
* component is rendered.
*/
public String getStyle() {
if (this.style != null) {
return this.style;
}
ValueExpression _vb = getValueExpression("style");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* CSS style(s) to be applied to the outermost HTML element when this
* component is rendered.
*/
public void setStyle(String style) {
this.style = style;
}
/**
* CSS style class(es) to be applied to the outermost HTML element when this
* component is rendered.
*/
public String getStyleClass() {
if (this.styleClass != null) {
return this.styleClass;
}
ValueExpression _vb = getValueExpression("styleClass");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* CSS style class(es) to be applied to the outermost HTML element when this
* component is rendered.
*/
public void setStyleClass(String styleClass) {
this.styleClass = styleClass;
}
/**
* The text to be displayed in the table column footer. The table column footer is
* displayed once per table, and is especially useful in tables with multiple
* groups of rows.
*/
public String getTableFooterText() {
if (this.tableFooterText != null) {
return this.tableFooterText;
}
ValueExpression _vb = getValueExpression("tableFooterText");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* The text to be displayed in the table column footer. The table column footer is
* displayed once per table, and is especially useful in tables with multiple
* groups of rows.
*/
public void setTableFooterText(String tableFooterText) {
this.tableFooterText = tableFooterText;
}
/**
* Sets the value of the title attribute for the HTML element.
* The specified text will display as a tooltip if the mouse cursor hovers
* over the HTML element.
*/
public String getToolTip() {
if (this.toolTip != null) {
return this.toolTip;
}
ValueExpression _vb = getValueExpression("toolTip");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Sets the value of the title attribute for the HTML element.
* The specified text will display as a tooltip if the mouse cursor hovers
* over the HTML element.
*/
public void setToolTip(String toolTip) {
this.toolTip = toolTip;
}
/**
* Use the valign attribute to specify the vertical alignment for the
* content of each cell in the column. Valid values are top,
* middle, bottom, and baseline. The
* default vertical alignment is middle. Setting the
* valign attribute to baseline causes the first line of
* each cell's content to be aligned on the text baseline, the invisible line on
* which text characters rest.
*/
public String getValign() {
if (this.valign != null) {
return this.valign;
}
ValueExpression _vb = getValueExpression("valign");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use the valign attribute to specify the vertical alignment for the
* content of each cell in the column. Valid values are top,
* middle, bottom, and baseline. The
* default vertical alignment is middle. Setting the
* valign attribute to baseline causes the first line of
* each cell's content to be aligned on the text baseline, the invisible line on
* which text characters rest.
*/
public void setValign(String valign) {
this.valign = valign;
}
/**
* Use the visible attribute to indicate whether the component should be
* viewable by the user in the rendered HTML page. If set to false, the
* HTML code for the component is present in the page, but the component
* is hidden with style attributes. By default, visible is set to true, so
* HTML for the component HTML is included and visible to the user. If the
* component is not visible, it can still be processed on subsequent form
* submissions because the HTML is present.
*/
public boolean isVisible() {
if (this.visible_set) {
return this.visible;
}
ValueExpression _vb = getValueExpression("visible");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return true;
}
/**
* Use the visible attribute to indicate whether the component should be
* viewable by the user in the rendered HTML page. If set to false, the
* HTML code for the component is present in the page, but the component
* is hidden with style attributes. By default, visible is set to true, so
* HTML for the component HTML is included and visible to the user. If the
* component is not visible, it can still be processed on subsequent form
* submissions because the HTML is present.
*/
public void setVisible(boolean visible) {
this.visible = visible;
this.visible_set = true;
}
/**
* Use the width attribute to specify the width of the cells of the
* column. The width can be specified as the number of pixels or the percentage of
* the table width, and is especially useful for spacer columns. This attribute is
* deprecated in HTML 4.0 in favor of style sheets.
*/
public String getWidth() {
if (this.width != null) {
return this.width;
}
ValueExpression _vb = getValueExpression("width");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Use the width attribute to specify the width of the cells of the
* column. The width can be specified as the number of pixels or the percentage of
* the table width, and is especially useful for spacer columns. This attribute is
* deprecated in HTML 4.0 in favor of style sheets.
*/
public void setWidth(String width) {
this.width = width;
}
/**
* Restore the state of this component.
*/
@Override
public void restoreState(FacesContext _context, Object _state) {
Object _values[] = (Object[]) _state;
super.restoreState(_context, _values[0]);
this.abbr = (String) _values[1];
this.align = (String) _values[2];
this.alignKey = (Object) _values[3];
this.axis = (String) _values[4];
this.bgColor = (String) _values[5];
this._char = (String) _values[6];
this.charOff = (String) _values[7];
this.colSpan = ((Integer) _values[8]).intValue();
this.colSpan_set = ((Boolean) _values[9]).booleanValue();
this.descending = ((Boolean) _values[10]).booleanValue();
this.descending_set = ((Boolean) _values[11]).booleanValue();
this.embeddedActions = ((Boolean) _values[12]).booleanValue();
this.embeddedActions_set = ((Boolean) _values[13]).booleanValue();
this.emptyCell = ((Boolean) _values[14]).booleanValue();
this.emptyCell_set = ((Boolean) _values[15]).booleanValue();
this.extraFooterHtml = (String) _values[16];
this.extraHeaderHtml = (String) _values[17];
this.extraTableFooterHtml = (String) _values[18];
this.footerText = (String) _values[19];
this.headerText = (String) _values[20];
this.headers = (String) _values[21];
this.height = (String) _values[22];
this.noWrap = ((Boolean) _values[23]).booleanValue();
this.noWrap_set = ((Boolean) _values[24]).booleanValue();
this.onClick = (String) _values[25];
this.onDblClick = (String) _values[26];
this.onKeyDown = (String) _values[27];
this.onKeyPress = (String) _values[28];
this.onKeyUp = (String) _values[29];
this.onMouseDown = (String) _values[30];
this.onMouseMove = (String) _values[31];
this.onMouseOut = (String) _values[32];
this.onMouseOver = (String) _values[33];
this.onMouseUp = (String) _values[34];
this.rowHeader = ((Boolean) _values[35]).booleanValue();
this.rowHeader_set = ((Boolean) _values[36]).booleanValue();
this.rowSpan = ((Integer) _values[37]).intValue();
this.rowSpan_set = ((Boolean) _values[38]).booleanValue();
this.scope = (String) _values[39];
this.selectId = (String) _values[40];
this.severity = (String) _values[41];
this.sort = (Object) _values[42];
this.sortIcon = (String) _values[43];
this.sortImageURL = (String) _values[44];
this.spacerColumn = ((Boolean) _values[45]).booleanValue();
this.spacerColumn_set = ((Boolean) _values[46]).booleanValue();
this.style = (String) _values[47];
this.styleClass = (String) _values[48];
this.tableFooterText = (String) _values[49];
this.toolTip = (String) _values[50];
this.valign = (String) _values[51];
this.visible = ((Boolean) _values[52]).booleanValue();
this.visible_set = ((Boolean) _values[53]).booleanValue();
this.width = (String) _values[54];
}
/**
* Save the state of this component.
*/
@Override
public Object saveState(FacesContext _context) {
Object _values[] = new Object[55];
_values[0] = super.saveState(_context);
_values[1] = this.abbr;
_values[2] = this.align;
_values[3] = this.alignKey;
_values[4] = this.axis;
_values[5] = this.bgColor;
_values[6] = this._char;
_values[7] = this.charOff;
_values[8] = new Integer(this.colSpan);
_values[9] = this.colSpan_set ? Boolean.TRUE : Boolean.FALSE;
_values[10] = this.descending ? Boolean.TRUE : Boolean.FALSE;
_values[11] = this.descending_set ? Boolean.TRUE : Boolean.FALSE;
_values[12] = this.embeddedActions ? Boolean.TRUE : Boolean.FALSE;
_values[13] = this.embeddedActions_set ? Boolean.TRUE : Boolean.FALSE;
_values[14] = this.emptyCell ? Boolean.TRUE : Boolean.FALSE;
_values[15] = this.emptyCell_set ? Boolean.TRUE : Boolean.FALSE;
_values[16] = this.extraFooterHtml;
_values[17] = this.extraHeaderHtml;
_values[18] = this.extraTableFooterHtml;
_values[19] = this.footerText;
_values[20] = this.headerText;
_values[21] = this.headers;
_values[22] = this.height;
_values[23] = this.noWrap ? Boolean.TRUE : Boolean.FALSE;
_values[24] = this.noWrap_set ? Boolean.TRUE : Boolean.FALSE;
_values[25] = this.onClick;
_values[26] = this.onDblClick;
_values[27] = this.onKeyDown;
_values[28] = this.onKeyPress;
_values[29] = this.onKeyUp;
_values[30] = this.onMouseDown;
_values[31] = this.onMouseMove;
_values[32] = this.onMouseOut;
_values[33] = this.onMouseOver;
_values[34] = this.onMouseUp;
_values[35] = this.rowHeader ? Boolean.TRUE : Boolean.FALSE;
_values[36] = this.rowHeader_set ? Boolean.TRUE : Boolean.FALSE;
_values[37] = new Integer(this.rowSpan);
_values[38] = this.rowSpan_set ? Boolean.TRUE : Boolean.FALSE;
_values[39] = this.scope;
_values[40] = this.selectId;
_values[41] = this.severity;
_values[42] = this.sort;
_values[43] = this.sortIcon;
_values[44] = this.sortImageURL;
_values[45] = this.spacerColumn ? Boolean.TRUE : Boolean.FALSE;
_values[46] = this.spacerColumn_set ? Boolean.TRUE : Boolean.FALSE;
_values[47] = this.style;
_values[48] = this.styleClass;
_values[49] = this.tableFooterText;
_values[50] = this.toolTip;
_values[51] = this.valign;
_values[52] = this.visible ? Boolean.TRUE : Boolean.FALSE;
_values[53] = this.visible_set ? Boolean.TRUE : Boolean.FALSE;
_values[54] = this.width;
return _values;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Private methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Helper method to get the number of columns found for this component that
* have a rendered property of true.
*
* @param component TableColumn to be rendered.
* @return The first selectId property found.
*/
private int getColumnCount(TableColumn component) {
int count = 0;
if (component == null) {
log("getColumnCount", //NOI18N
"Cannot obtain column count, TableColumn is null"); //NOI18N
return count;
}
// Get column count for nested TableColumn children.
Iterator kids = component.getTableColumnChildren();
if (kids.hasNext()) {
while (kids.hasNext()) {
TableColumn col = (TableColumn) kids.next();
if (!col.isRendered()) {
continue;
}
count += getColumnCount(col);
}
} else {
// Do not include root TableColumn nodes in count.
if (component.isRendered()) {
count++;
}
}
return count;
}
/**
* Helper method to get the number of rows found for this component that
* have a rendered property of true.
*
* @return The number of rendered rows.
*/
private int getRowCount() {
if (rowCount == -1) {
rowCount = 0; // Initialize min value.
// Get all TableColumn children at the same level of the tree.
Iterator kids = null;
TableColumn col = getTableColumnAncestor();
if (col != null) {
kids = col.getTableColumnChildren();
} else {
TableRowGroup group = getTableRowGroupAncestor();
kids = (group != null) ? group.getTableColumnChildren() : null;
}
// Get max row count for this level of the tree.
if (kids != null) {
while (kids.hasNext()) {
int result = getRowCount((TableColumn) kids.next());
if (rowCount < result) {
rowCount = result;
}
}
}
}
return rowCount;
}
/**
* Helper method to get the number of rows found for this component that
* have a rendered property of true.
*
* @param component TableColumn to be rendered.
* @return The first selectId property found.
*/
private int getRowCount(TableColumn component) {
int count = 0;
if (component == null) {
log("getRowCount", "Cannot obtain row count, TableColumn is null"); //NOI18N
return count;
}
// Get max row count for nested TableColumn children.
Iterator kids = component.getTableColumnChildren();
if (kids.hasNext()) {
while (kids.hasNext()) {
TableColumn col = (TableColumn) kids.next();
if (!col.isRendered()) {
continue;
}
int result = getRowCount(col);
if (count < result) {
count = result;
}
}
}
// Include root TableColumn component in count.
return ++count;
}
/**
* Helper method to get the data type of the data element referenced by the
* alignKey property.
*
* @return The data type of the data element.
*/
private Class getType() {
// Note: Avoid using getSourceData when possible. If developers do not
// cache their TableDataProvider objects, this may cause providers to be
// recreated, for each reference, which affects performance. Instead,
// get the type cached in TableRowGroup.
TableRowGroup group = getTableRowGroupAncestor();
if (group == null) {
log("getType", "Cannot obtain data type, TableRowGroup is null"); //NOI18N
return null;
}
// Get FieldKey.
FieldKey key = null;
if (getAlignKey() instanceof FieldKey) {
// If value binding resolves to FieldKey, use as is.
key = (FieldKey) getAlignKey();
} else if (getAlignKey() != null) {
try {
key = group.getFieldKey(getAlignKey().toString());
} catch (IllegalArgumentException e) {
log("getType", "Cannot obtain data type, object type may not be set"); //NOI18N
}
}
return (key != null) ? group.getType(key) : String.class;
}
/**
* Helper method to get Theme objects.
*
* @return The current theme.
*/
private Theme getTheme() {
return ThemeUtilities.getTheme(getFacesContext());
}
/**
* Helper method to test if column footers should be rendered.
*
* Note: Since headers and footers are optional, we do not render them by
* default. However, if any of the properties above are set, they must be
* set for all columns, including nested columns. Otherwise, we may end up
* with no header or footer and columns shift left. Alternatively,
* developers could add an empty string for each property.
*
*/
private boolean isColumnFooterRendered() {
boolean result = false; // Assume no headers or footers are used.
TableRowGroup group = getTableRowGroupAncestor();
if (group == null) {
log("isColumnFooterRendered", //NOI18N
"Cannot determine if column footer is rendered, TableRowGroup is null"); //NOI18N
return result;
}
// Test the footerText property for all TableColumn components.
Iterator kids = group.getTableColumnChildren();
while (kids.hasNext()) {
TableColumn col = (TableColumn) kids.next();
if (isColumnFooterRendered(col)) {
result = true;
break;
}
}
return result;
}
/**
* Helper method to test the footerText property for nested TableColumn
* components.
*
* @param component TableColumn component to render.
*/
private boolean isColumnFooterRendered(TableColumn component) {
boolean rendered = false;
if (component == null) {
log("isColumnFooterRendered", //NOI18N
"Cannot determine if column footer is rendered, TableColumn is null"); //NOI18N
return rendered;
}
// Test the footerText property for all TableColumn components.
Iterator kids = component.getTableColumnChildren();
if (kids.hasNext()) {
while (kids.hasNext()) {
TableColumn col = (TableColumn) kids.next();
if (isColumnFooterRendered(col)) {
// When footer text is found, don't go any further.
return true;
}
}
}
// If either a facet or text are defined, set rendered property.
UIComponent facet = component.getFacet(COLUMN_FOOTER_FACET);
if (facet != null && facet.isRendered() || component.getFooterText() != null) {
rendered = true;
}
return rendered;
}
/**
* Helper method to test if column headers should be rendered.
*
* Note: Since headers and footers are optional, we do not render them by
* default. However, if any of the properties above are set, they must be
* set for all columns, including nested columns. Otherwise, we may end up
* with no header or footer and columns shift left. Alternatively,
* developers could add an empty string for each property.
*
*/
private boolean isColumnHeaderRendered() {
boolean result = false; // Assume no headers or footers are used.
TableRowGroup group = getTableRowGroupAncestor();
if (group == null) {
log("isColumnHeaderRendered", //NOI18N
"Cannot determine if column header is rendered, TableRowGroup is null"); //NOI18N
return result;
}
// Test the headerText property for all TableColumn components.
Iterator kids = group.getTableColumnChildren();
while (kids.hasNext()) {
TableColumn col = (TableColumn) kids.next();
if (isColumnHeaderRendered(col)) {
result = true;
break;
}
}
return result;
}
/**
* Helper method to test the headerText property for nested TableColumn
* components.
*
* @param component TableColumn component to render.
*/
private boolean isColumnHeaderRendered(TableColumn component) {
boolean rendered = false;
if (component == null) {
log("isColumnHeaderRendered", //NOI18N
"Cannot determine if column header is rendered, TableColumn is null"); //NOI18N
return rendered;
}
// Test the headerText property for all TableColumn components.
Iterator kids = component.getTableColumnChildren();
if (kids.hasNext()) {
while (kids.hasNext()) {
TableColumn col = (TableColumn) kids.next();
if (isColumnHeaderRendered(col)) {
// When header text is found, don't go any further.
return true;
}
}
}
// If either a facet or text are defined, set rendered property.
UIComponent facet = component.getFacet(COLUMN_HEADER_FACET);
if (facet != null && facet.isRendered() || component.getHeaderText() != null) {
rendered = true;
}
return rendered;
}
/**
* Helper method to determine if table is empty.
*
* Note: We must determine if column headers are available for all or
* individual TableRowGroup components. That is, there could be a single
* column header for all row groups or one for each group. If there is more
* than one column header, we must test the row count of all groups. If
* there is only one column header and other groups have more than one row,
* we want to make sorting available. Thus, sorting is available only there
* is more than on row for all row groups.
*
* @return true if sorting should be available, else false.
*/
private boolean isEmptyTable() {
boolean result = false;
Table table = getTableAncestor();
TableRowGroup group = getTableRowGroupAncestor();
if (table != null && group != null) {
// Get total rows and headers for all TableRowGroup components.
int rows = table.getRowCount();
int headers = table.getColumnHeadersCount();
result = (headers > 1)
? !(group.getRowCount() > 1) // Test individual groups.
: rows == 0 || rows == 1; // No sorting for single row.
}
return result;
}
/**
* Helper method to test if table column footers should be rendered.
*
* Note: Since headers and footers are optional, we do not render them by
* default. However, if any of the properties above are set, they must be
* set for all columns, including nested columns. Otherwise, we may end up
* with no header or footer and columns shift left. Alternatively,
* developers could add an empty string for each property.
*
*/
private boolean isTableColumnFooterRendered() {
boolean result = false; // Assume no headers or footers are used.
TableRowGroup group = getTableRowGroupAncestor();
if (group == null) {
log("isTableColumnFooterRendered", //NOI18N
"Cannot determine if table column footer is rendered, TableRowGroup is null"); //NOI18N
return result;
}
// Test the tableFooterText property for all TableColumn components.
Iterator kids = group.getTableColumnChildren();
while (kids.hasNext()) {
TableColumn col = (TableColumn) kids.next();
if (isTableColumnFooterRendered(col)) {
result = true;
break;
}
}
return result;
}
/**
* Helper method to test the tableFooterText property for nested TableColumn
* components.
*
* @param component TableColumn component to render.
*/
private boolean isTableColumnFooterRendered(TableColumn component) {
boolean rendered = false;
if (component == null) {
log("isTableColumnFooterRendered", //NOI18N
"Cannot determine if table column footer is rendered, TableColumn is null"); //NOI18N
return rendered;
}
// Test the tableFooterText property for all TableColumn components.
Iterator kids = component.getTableColumnChildren();
if (kids.hasNext()) {
while (kids.hasNext()) {
TableColumn col = (TableColumn) kids.next();
if (isTableColumnFooterRendered(col)) {
// When footer text is found, don't go any further.
return true;
}
}
}
// If either a facet or text are defined, set rendered property.
UIComponent facet = component.getFacet(TABLE_FOOTER_FACET);
if (facet != null && facet.isRendered() || component.getTableFooterText() != null) {
rendered = true;
}
return rendered;
}
/**
* Log fine messages.
*/
private void log(String method, String message) {
// Get class.
Class clazz = this.getClass();
if (LogUtil.fineEnabled(clazz)) {
// Log method name and message.
LogUtil.fine(clazz, clazz.getName() + "." + method + ": " + message); //NOI18N
}
}
}