com.sun.webui.jsf.component.TableHeader Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://woodstock.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at https://woodstock.dev.java.net/public/CDDLv1.0.html.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
*/
package com.sun.webui.jsf.component;
import com.sun.faces.annotation.Component;
import com.sun.faces.annotation.Property;
import com.sun.data.provider.RowKey;
import com.sun.webui.jsf.event.TableSortActionListener;
import com.sun.webui.jsf.theme.ThemeImages;
import com.sun.webui.jsf.theme.ThemeStyles;
import com.sun.webui.jsf.util.LogUtil;
import com.sun.webui.jsf.util.ThemeUtilities;
import com.sun.webui.theme.Theme;
import java.io.IOException;
import javax.el.ValueExpression;
import javax.faces.component.NamingContainer;
import javax.faces.component.UIComponent;
import javax.faces.component.UIComponentBase;
import javax.faces.context.FacesContext;
/**
* Component that represents various table headers, including sortable,
* selection, and group headers.
*
* 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.webui.jsf.component.TableHeader.level = FINE
*
*/
@Component(type = "com.sun.webui.jsf.TableHeader",
family = "com.sun.webui.jsf.TableHeader", displayName = "Header", isTag = false)
public class TableHeader extends UIComponentBase implements NamingContainer {
/** The component id for the add sort button. */
public static final String ADD_SORT_BUTTON_ID = "_addSortButton"; //NOI18N
/** The facet name for the add sort button. */
public static final String ADD_SORT_BUTTON_FACET = "addSortButton"; //NOI18N
/** The component id for the collapsed hidden field. */
public static final String COLLAPSED_HIDDEN_FIELD_ID = "_collapsedHiddenField"; //NOI18N
/** The facet name for the collapsed hidden field. */
public static final String COLLAPSED_HIDDEN_FIELD_FACET = "collapsedHiddenField"; //NOI18N
/** The component id for the table row group toggle button. */
public static final String GROUP_PANEL_TOGGLE_BUTTON_ID = "_groupPanelToggleButton"; //NOI18N
/** The facet name for the table row group toggle button. */
public static final String GROUP_PANEL_TOGGLE_BUTTON_FACET = "groupPanelToggleButton"; //NOI18N
/** The component id for the primary sort button. */
public static final String PRIMARY_SORT_BUTTON_ID = "_primarySortButton"; //NOI18N
/** The facet name for the primary sort button. */
public static final String PRIMARY_SORT_BUTTON_FACET = "primarySortButton"; //NOI18N
/** The component id for the primary sort link. */
public static final String PRIMARY_SORT_LINK_ID = "_primarySortLink"; //NOI18N
/** The facet name for the primary sort link. */
public static final String PRIMARY_SORT_LINK_FACET = "primarySortLink"; //NOI18N
/** The component id for the select multiple toggle button. */
public static final String SELECT_MULTIPLE_TOGGLE_BUTTON_ID = "_selectMultipleToggleButton"; //NOI18N
/** The facet name for the select multiple toggle button. */
public static final String SELECT_MULTIPLE_TOGGLE_BUTTON_FACET = "selectMultipleToggleButton"; //NOI18N
/** The component id for the selection column sort button. */
public static final String SELECT_SORT_BUTTON_ID = "_selectSortButton"; //NOI18N
/** The facet name for the selection column sort button. */
public static final String SELECT_SORT_BUTTON_FACET = "selectSortButton"; //NOI18N
/** The component id for the sort level text. */
public static final String SORT_LEVEL_TEXT_ID = "_sortLevelText"; //NOI18N
/** The facet name for the sort level text. */
public static final String SORT_LEVEL_TEXT_FACET = "sortLevelText"; //NOI18N
/** The component id for the toggle sort button. */
public static final String TOGGLE_SORT_BUTTON_ID = "_toggleSortButton"; //NOI18N
/** The facet name for the toggle sort button. */
public static final String TOGGLE_SORT_BUTTON_FACET = "toggleSortButton"; //NOI18N
/** The component id for the warning icon. */
public static final String WARNING_ICON_ID = "_warningIcon"; //NOI18N
/** The facet name for the warning icon. */
public static final String WARNING_ICON_FACET = "warningIcon"; //NOI18N
// The Table ancestor enclosing this component.
private Table table = null;
// The TableColumn ancestor enclosing this component.
private TableColumn tableColumn = null;
// The TableRowGroup ancestor enclosing this component.
private TableRowGroup tableRowGroup = null;
// Flag indicating that the next sort order is descending.
private boolean descending = false;
private boolean descending_set = false;
// The total number of selected rows.
private int selectedRowsCount = -1;
// The total number of sorts applied.
private int sortCount = -1;
// Sort level for this component.
private int sortLevel = -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")
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")
private String align = 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")
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")
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")
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")
private String charOff = null;
/**
* The COLSPAN attribute of TH 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")
private int colSpan = Integer.MIN_VALUE;
private boolean colSpan_set = false;
/**
* Extra HTML to be appended to the tag output by this renderer.
*/
@Property(name = "extraHtml", displayName = "Extra HTML")
private String extraHtml = null;
/**
* Flag indicating this component should render a group header. The default renders
* a column header. This should not be used if selectHeader or sortHeader are used.
*/
@Property(name = "groupHeader", displayName = "Is Group Header", isAttribute = false)
private boolean groupHeader = false;
private boolean groupHeader_set = false;
/**
* The HEADERS attribute specifies the header cells that apply to the
* TH. 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")
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")
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")
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")
private String onClick = null;
/**
* Scripting code executed when a mouse double click
* occurs over this component.
*/
@Property(name = "onDblClick", displayName = "Double Click Script")
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")
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")
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")
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")
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")
private String onMouseMove = null;
/**
* Scripting code executed when a mouse out movement
* occurs over this component.
*/
@Property(name = "onMouseOut", displayName = "Mouse Out Script")
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")
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")
private String onMouseUp = null;
/**
* The ROWSPAN attribute of TH 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")
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")
private String scope = null;
/**
* Flag indicating this component should render a selection column header. The
* default renders a column header. This should not be used if groupHeader or
* sortHeader are used.
*/
@Property(name = "selectHeader", displayName = "Is Select Header", isAttribute = false)
private boolean selectHeader = false;
private boolean selectHeader_set = false;
/**
* Flag indicating this component should render a sortable column header. The
* default renders a column header. This should not be used if groupHeader or
* selectHeader are used.
*/
@Property(name = "sortHeader", displayName = "Is Sort Header", isAttribute = false)
private boolean sortHeader = false;
private boolean sortHeader_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)")
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)")
private String styleClass = 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")
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")
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")
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")
private String width = null;
/** Default constructor */
public TableHeader() {
super();
setRendererType("com.sun.webui.jsf.TableHeader");
}
/**
* Return the family for this component.
*/
public String getFamily() {
return "com.sun.webui.jsf.TableHeader";
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Child methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Helper method to get the total number of sorts applied.
*
* @return The sort count.
*/
public int getSortCount() {
if (sortCount == -1) {
TableRowGroup group = getTableRowGroupAncestor();
sortCount = (group != null) ? group.getSortCount() : 0;
}
return sortCount;
}
/**
* Helper method to get sort level for this component.
*
* @return The sort level or 0 if sort does not apply.
*/
public int getSortLevel() {
if (sortLevel == -1) {
TableColumn col = getTableColumnAncestor();
TableRowGroup group = getTableRowGroupAncestor();
if (col != null && group != null) {
sortLevel = group.getSortLevel(col.getSortCriteria());
} else {
log("getSortLevel", //NOI18N
"Cannot obtain sort level, TableColumn or TableRowGroup is null"); //NOI18N
}
}
return sortLevel;
}
/**
* Get the closest Table ancestor that encloses this component.
*
* @return The Table ancestor.
*/
public Table getTableAncestor() {
if (table == null) {
UIComponent component = this;
while (component != null) {
component = component.getParent();
if (component instanceof Table) {
table = (Table) component;
break;
}
}
}
return table;
}
/**
* Get the closest TableColumn ancestor that encloses this component.
*
* @return The TableColumn ancestor.
*/
public TableColumn getTableColumnAncestor() {
if (tableColumn == null) {
UIComponent component = this;
while (component != null) {
component = component.getParent();
if (component instanceof TableColumn) {
tableColumn = (TableColumn) component;
break;
}
}
}
return tableColumn;
}
/**
* Get the closest TableRowGroup ancestor that encloses this component.
*
* @return The TableRowGroup ancestor.
*/
public TableRowGroup getTableRowGroupAncestor() {
if (tableRowGroup == null) {
UIComponent component = this;
while (component != null) {
component = component.getParent();
if (component instanceof TableRowGroup) {
tableRowGroup = (TableRowGroup) component;
break;
}
}
}
return tableRowGroup;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Group methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Get select multiple toggle button.
*
* @return The select multiple toggle button.
*/
public UIComponent getCollapsedHiddenField() {
UIComponent facet = getFacet(COLLAPSED_HIDDEN_FIELD_FACET);
if (facet != null) {
return facet;
}
// Get child.
HiddenField child = new HiddenField();
child.setId(COLLAPSED_HIDDEN_FIELD_ID);
// Set value.
TableRowGroup group = getTableRowGroupAncestor();
if (group != null) {
child.setText(new Boolean(group.isCollapsed()));
} else {
log("getCollapsedHiddenField", //NOI18N
"Cannot set collapsed hidden field value, TableRowGroup is null"); //NOI18N
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
/**
* Get group panel toggle button.
*
* @return The group panel toggle button.
*/
public UIComponent getGroupPanelToggleButton() {
UIComponent facet = getFacet(GROUP_PANEL_TOGGLE_BUTTON_FACET);
if (facet != null) {
return facet;
}
Theme theme = getTheme();
Table table = getTableAncestor();
TableRowGroup group = getTableRowGroupAncestor();
// Get child.
IconHyperlink child = new IconHyperlink();
child.setId(GROUP_PANEL_TOGGLE_BUTTON_ID);
child.setIcon((group != null && group.isCollapsed())
? ThemeImages.TABLE_GROUP_PANEL
: ThemeImages.TABLE_GROUP_PANEL_FLIP);
child.setBorder(0);
// Set JS to display table preferences panel.
StringBuffer buff = new StringBuffer(128);
if (table != null && group != null) {
buff.append("document.getElementById('") //NOI18N
.append(table.getClientId(getFacesContext())).append("').toggleGroupPanel('") //NOI18N
.append(group.getClientId(getFacesContext())).append("'); return false"); //NOI18N
child.setOnClick(buff.toString());
} else {
log("getGroupPanelToggleButton", //NOI18N
"onClick not set, Table or TableRowGroup is null"); //NOI18N
}
// Set tool tip.
String toolTip = (group != null && group.isCollapsed())
? theme.getMessage("table.group.expand") //NOI18N
: theme.getMessage("table.group.collapse"); //NOI18N
child.setAlt(toolTip);
child.setToolTip(toolTip);
// Set tab index.
if (table != null) {
child.setTabIndex(table.getTabIndex());
} else {
log("getGroupPanelToggleButton", "Tab index not set, Table is null"); //NOI18N
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
/**
* Get select multiple toggle button.
*
* @return The select multiple toggle button.
*/
public UIComponent getSelectMultipleToggleButton() {
UIComponent facet = getFacet(SELECT_MULTIPLE_TOGGLE_BUTTON_FACET);
if (facet != null) {
return facet;
}
Table table = getTableAncestor();
TableRowGroup group = getTableRowGroupAncestor();
// Get child.
Checkbox child = new Checkbox();
child.setId(SELECT_MULTIPLE_TOGGLE_BUTTON_ID);
child.setSelectedValue(Boolean.TRUE);
// Set JS to display table preferences panel.
StringBuffer buff = new StringBuffer(128);
if (table != null && group != null) {
buff.append("document.getElementById('") //NOI18N
.append(table.getClientId(getFacesContext())).append("').selectGroupRows('") //NOI18N
.append(group.getClientId(getFacesContext())).append("', this.checked)"); //NOI18N
child.setOnClick(buff.toString());
} else {
log("getSelectMultipleToggleButton", //NOI18N
"onClick not set, Table or TableRowgroup is null"); //NOI18N
}
// Set selected property.
if (group != null) {
// Checkbox is checked only if all rendered rows are selected.
RowKey[] rowKeys = group.getRenderedRowKeys();
if (rowKeys != null && rowKeys.length > 0 && rowKeys.length == getSelectedRowsCount()) {
child.setSelected(Boolean.TRUE);
child.setToolTip(getTheme().getMessage(
"table.group.deselectMultiple")); //NOI18N
} else {
child.setToolTip(getTheme().getMessage(
"table.group.selectMultiple")); //NOI18N
}
} else {
log("getSelectMultipleToggleButton", //NOI18N
"Tool tip & selected not set, TableRowGroup is null"); //NOI18N
}
// Set tab index.
if (table != null) {
child.setTabIndex(table.getTabIndex());
} else {
log("getSelectMultipleToggleButton", //NOI18N
"Tab index not set, Table is null"); //NOI18N
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
/**
* Get warning icon.
*
* @return The warning icon.
*/
public UIComponent getWarningIcon() {
UIComponent facet = getFacet(WARNING_ICON_FACET);
if (facet != null) {
return facet;
}
Theme theme = getTheme();
TableRowGroup group = getTableRowGroupAncestor();
// Get child.
Icon child = ThemeUtilities.getIcon(theme,
ThemeImages.ALERT_WARNING_SMALL);
// Warning icon is only rendered if at least one row is selected and the
// select multiple toggle is not checked.
RowKey[] rowKeys = group.getRenderedRowKeys();
int rows = getSelectedRowsCount();
if (group != null && !group.isCollapsed() || rows == 0 || rowKeys != null && rowKeys.length > 0 && rowKeys.length == rows) {
// Replace default icon with place holder.
Icon placeHolder = ThemeUtilities.getIcon(theme, ThemeImages.DOT);
placeHolder.setHeight(child.getHeight());
placeHolder.setWidth(child.getWidth());
child = placeHolder;
} else {
log("getWarningIcon", //NOI18N
"Height & width not set, TableRowGroup is null"); //NOI18N
}
child.setId(WARNING_ICON_ID);
child.setBorder(0);
// Set tool tip.
String toolTip = (group != null && group.isCollapsed())
? theme.getMessage("table.group.warning") : null; //NOI18N
child.setAlt(toolTip);
child.setToolTip(toolTip);
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Sort methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Get add sort button.
*
* @return The add sort button.
*/
public UIComponent getAddSortButton() {
UIComponent facet = getFacet(ADD_SORT_BUTTON_FACET);
if (facet != null) {
return facet;
}
Theme theme = getTheme();
Table table = getTableAncestor();
TableColumn col = getTableColumnAncestor();
// Get child.
IconHyperlink child = new IconHyperlink();
child.setId(ADD_SORT_BUTTON_ID);
child.setIcon(ThemeImages.TABLE_SORT_ADD);
child.setBorder(0);
child.setAlign("top"); //NOI18N
child.setStyleClass(
theme.getStyleClass(ThemeStyles.TABLE_HEADER_LINK_IMG));
child.addActionListener(new TableSortActionListener());
// Set tool tip.
String toolTip = getTheme().getMessage("table.sort.button.add", //NOI18N
new String[]{getNextSortToolTipAugment()});
child.setToolTip(toolTip);
// Set alt.
if (isSelectHeader()) {
child.setAlt(theme.getMessage("table.sort.alt.add", //NOI18N
new String[]{theme.getMessage("table.select.selectionColumn")})); //NOI18N
} else {
String header = (col != null && col.getHeaderText() != null)
? col.getHeaderText() : ""; //NOI18N
// Select column does not have header text.
child.setAlt(theme.getMessage("table.sort.alt.add", //NOI18N
new String[]{header}));
}
// Set tab index.
if (table != null) {
child.setTabIndex(table.getTabIndex());
} else {
log("getAddSortButton", "Tab index not set, Table is null"); //NOI18N
}
// Add sort level text child.
if (getSortCount() > 0 && getSortLevel() > 0) {
// Span must appear within hyperlink for style to render properly.
child.getChildren().add(getSortLevelText());
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
/**
* Get primary sort button.
*
* @return The primary sort button.
*/
public UIComponent getPrimarySortButton() {
UIComponent facet = getFacet(PRIMARY_SORT_BUTTON_FACET);
if (facet != null) {
return facet;
}
Theme theme = getTheme();
Table table = getTableAncestor();
TableColumn col = getTableColumnAncestor();
// Get child.
IconHyperlink child = new IconHyperlink();
child.setId(PRIMARY_SORT_BUTTON_ID);
child.setIcon(ThemeImages.TABLE_SORT_PRIMARY);
child.setBorder(0);
child.setAlign("top"); //NOI18N
child.setStyleClass(
theme.getStyleClass(ThemeStyles.TABLE_HEADER_LINK_IMG));
child.addActionListener(new TableSortActionListener());
// Set tool tip.
String toolTip = theme.getMessage("table.sort.button.primary", //NOI18N
new String[]{getNextSortToolTipAugment()});
child.setToolTip(toolTip);
// Set alt.
if (col != null) {
String header = (col.getHeaderText() != null)
? col.getHeaderText() : ""; //NOI18N
child.setAlt(theme.getMessage("table.sort.alt.primary", //NOI18N
new String[]{header}));
} else {
log("getPrimarySortButton", "Alt text not set, TableColumn is null"); //NOI18N
}
// Set tab index.
if (table != null) {
child.setTabIndex(table.getTabIndex());
} else {
log("getPrimarySortButton", "Tab index not set, Table is null"); //NOI18N
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
/**
* Get primary sort link.
*
* @return The primary sort link.
*/
public UIComponent getPrimarySortLink() {
UIComponent facet = getFacet(PRIMARY_SORT_LINK_FACET);
if (facet != null) {
return facet;
}
Theme theme = getTheme();
Table table = getTableAncestor();
TableColumn col = getTableColumnAncestor();
// Get child.
IconHyperlink child = new IconHyperlink();
child.setId(PRIMARY_SORT_LINK_ID);
child.setStyleClass(theme.getStyleClass(ThemeStyles.TABLE_HEADER_LINK));
child.addActionListener(new TableSortActionListener());
// Get tool tip.
String toolTip = "table.sort.link.other"; //NOI18N
if (getSortLevel() == 1 && getSortCount() == 1) {
// Primary sort column, only sort applied.
toolTip = "table.sort.link.primary"; //NOI18N
} else if (getSortCount() == 0) {
// No sorts applied.
toolTip = "table.sort.link.none"; //NOI18N
}
// Set column properties.
if (col != null) {
child.setIcon(col.getSortIcon());
child.setText(col.getHeaderText());
child.setImageURL(col.getSortImageURL());
child.setToolTip(getTheme().getMessage(toolTip,
new String[]{col.getSortToolTipAugment(col.isDescending())}));
} else {
log("getPrimarySortLink", //NOI18N
"Tool tip, icon, text, & image URL not set, TableColumn is null"); //NOI18N
}
// Set tab index.
if (table != null) {
child.setTabIndex(table.getTabIndex());
} else {
log("getPrimarySortLink", "Tab index not set, Table is null"); //NOI18N
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
/**
* Get select sort button.
*
* @return The title sort button.
*/
public UIComponent getSelectSortButton() {
UIComponent facet = getFacet(SELECT_SORT_BUTTON_FACET);
if (facet != null) {
return facet;
}
Theme theme = getTheme();
Table table = getTableAncestor();
// Get child.
IconHyperlink child = new IconHyperlink();
child.setId(SELECT_SORT_BUTTON_ID);
child.setIcon(ThemeImages.TABLE_SORT_SELECT);
child.setBorder(0);
child.setAlign("top"); //NOI18N
child.setStyleClass(
theme.getStyleClass(ThemeStyles.TABLE_HEADER_LINK));
child.addActionListener(new TableSortActionListener());
// Get tool tip. Note: Use same tooltip as link -- bugtraq #6339188.
String toolTip = "table.sort.link.other"; //NOI18N
if (getSortLevel() == 1 && getSortCount() == 1) {
// Primary sort column, only sort applied.
toolTip = "table.sort.link.primary"; //NOI18N
} else if (getSortCount() == 0) {
// No sorts applied.
toolTip = "table.sort.link.none"; //NOI18N
}
// Set tool tip.
child.setToolTip(theme.getMessage(toolTip, //NOI18N
new String[]{getNextSortToolTipAugment()}));
// Set alt.
String alt = theme.getMessage("table.sort.alt.primary", //NOI18N
new String[]{theme.getMessage("table.select.selectionColumn")}); //NOI18N
child.setAlt(alt);
// Set tab index.
if (table != null) {
child.setTabIndex(table.getTabIndex());
} else {
log("getSelectSortButton", "Tab index not set, Table is null"); //NOI18N
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
/**
* Get sort level static text.
*
* @return The sort level static text.
*/
public UIComponent getSortLevelText() {
UIComponent facet = getFacet(SORT_LEVEL_TEXT_FACET);
if (facet != null) {
return facet;
}
// Get child.
StaticText child = new StaticText();
child.setId(SORT_LEVEL_TEXT_ID);
child.setText(Integer.toString(getSortLevel()));
child.setStyleClass(getTheme().getStyleClass(
ThemeStyles.TABLE_HEADER_SORTNUM));
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
/**
* Get toggle sort button.
*
* @return The toggle sort button.
*/
public UIComponent getToggleSortButton() {
UIComponent facet = getFacet(TOGGLE_SORT_BUTTON_FACET);
if (facet != null) {
return facet;
}
Theme theme = getTheme();
Table table = getTableAncestor();
TableColumn col = getTableColumnAncestor();
TableRowGroup group = getTableRowGroupAncestor();
// Get child.
IconHyperlink child = new IconHyperlink();
child.setId(TOGGLE_SORT_BUTTON_ID);
child.setBorder(0);
child.setAlign("top"); //NOI18N
child.addActionListener(new TableSortActionListener());
// Disable descending sort so selections don't move off page.
if (table != null && col != null) {
if (!isDescending() && group.isPaginated() && col.getSelectId() != null && !table.isHiddenSelectedRows()) {
child.setDisabled(true);
}
} else {
log("getToggleSortButton", //NOI18N
"Disabled state not set, Table or TableColumn is null"); //NOI18N
}
// Set alt and tool tip for the next sort applied.
if (col != null) {
// Get tool tip.
child.setToolTip(theme.getMessage("table.sort.button.toggle", //NOI18N
new String[]{col.getSortToolTipAugment(!isDescending())}));
// Get alt.
if (isSelectHeader()) {
// Select column does not have header text.
child.setAlt(theme.getMessage("table.sort.alt.primary", //NOI18N
new String[]{theme.getMessage("table.select.selectionColumn"), //NOI18N
col.getSortToolTipAugment(isDescending()),
Integer.toString(getSortLevel())}));
} else {
String header = (col.getHeaderText() != null)
? col.getHeaderText() : ""; //NOI18N
child.setAlt(theme.getMessage("table.sort.alt.toggle", //NOI18N
new String[]{header,
col.getSortToolTipAugment(isDescending()),
Integer.toString(getSortLevel())}));
}
} else {
log("getToggleSortButton", "Alt text not set, TableColumn is null"); //NOI18N
}
// Set icon for the next sort applied.
if (child.isDisabled()) {
child.setIcon(ThemeImages.TABLE_SORT_DESCENDING_DISABLED);
} else if (!isDescending()) {
child.setIcon(ThemeImages.TABLE_SORT_DESCENDING);
} else {
child.setIcon(ThemeImages.TABLE_SORT_ASCENDING);
}
// Set styleClass.
if (child.isDisabled()) {
if (getSortLevel() == 1) {
child.setStyleClass(
theme.getStyleClass(ThemeStyles.TABLE_HEADER_SORT_DISABLED));
} else {
child.setStyleClass(
theme.getStyleClass(ThemeStyles.TABLE_HEADER_SELECTCOL_DISABLED));
}
} else {
child.setStyleClass(
theme.getStyleClass(ThemeStyles.TABLE_HEADER_LINK_IMG));
}
// Add sort level text.
if (getSortLevel() > 0 && getSortCount() > 0) {
// Span must appear within hyperlink for style to render properly.
child.getChildren().add(getSortLevelText());
}
// Set tab index.
if (table != null) {
child.setTabIndex(table.getTabIndex());
} else {
log("getToggleSortButton", "Tab index not set, Table is null"); //NOI18N
}
// Save facet and return child.
getFacets().put(child.getId(), child);
return child;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// UIComponent methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* If the rendered property is true, render the begining of the current
* state of this UIComponent to the response contained in the specified
* FacesContext.
*
* If a Renderer is associated with this UIComponent, the actual encoding
* will be delegated to Renderer.encodeBegin(FacesContext, UIComponent).
*
* @param context FacesContext for the current request.
*
* @exception IOException if an input/output error occurs while rendering.
* @exception NullPointerException if FacesContext is null.
*/
@Override
public void encodeBegin(FacesContext context) throws IOException {
// Clear cached variables -- bugtraq #6300020.
table = null;
tableColumn = null;
tableRowGroup = null;
descending = false;
descending_set = false;
selectedRowsCount = -1;
sortCount = -1;
sortLevel = -1;
super.encodeBegin(context);
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Tag attribute methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* 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.
*/
public String getAlign() {
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;
}
/**
* 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 TH 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 TH 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;
}
/**
* Extra HTML to be appended to the tag output by this renderer.
*/
public String getExtraHtml() {
if (this.extraHtml != null) {
return this.extraHtml;
}
ValueExpression _vb = getValueExpression("extraHtml");
if (_vb != null) {
return (String) _vb.getValue(getFacesContext().getELContext());
}
return null;
}
/**
* Extra HTML to be appended to the tag output by this renderer.
*/
public void setExtraHtml(String extraHtml) {
this.extraHtml = extraHtml;
}
/**
* Flag indicating this component should render a group header. The default renders
* a column header. This should not be used if selectHeader or sortHeader are used.
*/
public boolean isGroupHeader() {
if (this.groupHeader_set) {
return this.groupHeader;
}
ValueExpression _vb = getValueExpression("groupHeader");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Flag indicating this component should render a group header. The default renders
* a column header. This should not be used if selectHeader or sortHeader are used.
*/
public void setGroupHeader(boolean groupHeader) {
this.groupHeader = groupHeader;
this.groupHeader_set = true;
}
/**
* The HEADERS attribute specifies the header cells that apply to the
* TH. 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
* TH. 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;
}
/**
* The ROWSPAN attribute of TH 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 TH 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;
}
/**
* Flag indicating this component should render a selection column header. The
* default renders a column header. This should not be used if groupHeader or
* sortHeader are used.
*/
public boolean isSelectHeader() {
if (this.selectHeader_set) {
return this.selectHeader;
}
ValueExpression _vb = getValueExpression("selectHeader");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Flag indicating this component should render a selection column header. The
* default renders a column header. This should not be used if groupHeader or
* sortHeader are used.
*/
public void setSelectHeader(boolean selectHeader) {
this.selectHeader = selectHeader;
this.selectHeader_set = true;
}
/**
* Flag indicating this component should render a sortable column header. The
* default renders a column header. This should not be used if groupHeader or
* selectHeader are used.
*/
public boolean isSortHeader() {
if (this.sortHeader_set) {
return this.sortHeader;
}
ValueExpression _vb = getValueExpression("sortHeader");
if (_vb != null) {
Object _result = _vb.getValue(getFacesContext().getELContext());
if (_result == null) {
return false;
} else {
return ((Boolean) _result).booleanValue();
}
}
return false;
}
/**
* Flag indicating this component should render a sortable column header. The
* default renders a column header. This should not be used if groupHeader or
* selectHeader are used.
*/
public void setSortHeader(boolean sortHeader) {
this.sortHeader = sortHeader;
this.sortHeader_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;
}
/**
* 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.axis = (String) _values[3];
this.bgColor = (String) _values[4];
this._char = (String) _values[5];
this.charOff = (String) _values[6];
this.colSpan = ((Integer) _values[7]).intValue();
this.colSpan_set = ((Boolean) _values[8]).booleanValue();
this.extraHtml = (String) _values[9];
this.groupHeader = ((Boolean) _values[10]).booleanValue();
this.groupHeader_set = ((Boolean) _values[11]).booleanValue();
this.headers = (String) _values[12];
this.height = (String) _values[13];
this.noWrap = ((Boolean) _values[14]).booleanValue();
this.noWrap_set = ((Boolean) _values[15]).booleanValue();
this.onClick = (String) _values[16];
this.onDblClick = (String) _values[17];
this.onKeyDown = (String) _values[18];
this.onKeyPress = (String) _values[19];
this.onKeyUp = (String) _values[20];
this.onMouseDown = (String) _values[21];
this.onMouseMove = (String) _values[22];
this.onMouseOut = (String) _values[23];
this.onMouseOver = (String) _values[24];
this.onMouseUp = (String) _values[25];
this.rowSpan = ((Integer) _values[26]).intValue();
this.rowSpan_set = ((Boolean) _values[27]).booleanValue();
this.scope = (String) _values[28];
this.selectHeader = ((Boolean) _values[29]).booleanValue();
this.selectHeader_set = ((Boolean) _values[30]).booleanValue();
this.sortHeader = ((Boolean) _values[31]).booleanValue();
this.sortHeader_set = ((Boolean) _values[32]).booleanValue();
this.style = (String) _values[33];
this.styleClass = (String) _values[34];
this.toolTip = (String) _values[35];
this.valign = (String) _values[36];
this.visible = ((Boolean) _values[37]).booleanValue();
this.visible_set = ((Boolean) _values[38]).booleanValue();
this.width = (String) _values[39];
}
/**
* Save the state of this component.
*/
@Override
public Object saveState(FacesContext _context) {
Object _values[] = new Object[40];
_values[0] = super.saveState(_context);
_values[1] = this.abbr;
_values[2] = this.align;
_values[3] = this.axis;
_values[4] = this.bgColor;
_values[5] = this._char;
_values[6] = this.charOff;
_values[7] = new Integer(this.colSpan);
_values[8] = this.colSpan_set ? Boolean.TRUE : Boolean.FALSE;
_values[9] = this.extraHtml;
_values[10] = this.groupHeader ? Boolean.TRUE : Boolean.FALSE;
_values[11] = this.groupHeader_set ? Boolean.TRUE : Boolean.FALSE;
_values[12] = this.headers;
_values[13] = this.height;
_values[14] = this.noWrap ? Boolean.TRUE : Boolean.FALSE;
_values[15] = this.noWrap_set ? Boolean.TRUE : Boolean.FALSE;
_values[16] = this.onClick;
_values[17] = this.onDblClick;
_values[18] = this.onKeyDown;
_values[19] = this.onKeyPress;
_values[20] = this.onKeyUp;
_values[21] = this.onMouseDown;
_values[22] = this.onMouseMove;
_values[23] = this.onMouseOut;
_values[24] = this.onMouseOver;
_values[25] = this.onMouseUp;
_values[26] = new Integer(this.rowSpan);
_values[27] = this.rowSpan_set ? Boolean.TRUE : Boolean.FALSE;
_values[28] = this.scope;
_values[29] = this.selectHeader ? Boolean.TRUE : Boolean.FALSE;
_values[30] = this.selectHeader_set ? Boolean.TRUE : Boolean.FALSE;
_values[31] = this.sortHeader ? Boolean.TRUE : Boolean.FALSE;
_values[32] = this.sortHeader_set ? Boolean.TRUE : Boolean.FALSE;
_values[33] = this.style;
_values[34] = this.styleClass;
_values[35] = this.toolTip;
_values[36] = this.valign;
_values[37] = this.visible ? Boolean.TRUE : Boolean.FALSE;
_values[38] = this.visible_set ? Boolean.TRUE : Boolean.FALSE;
_values[39] = this.width;
return _values;
}
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
// Private methods
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/**
* Helper method to get next sort tool tip augment based on the value for
* the align property of TableColumn.
*
* @param descending Flag indicating descending sort.
* @return The sort tool tip augment.
*/
private String getNextSortToolTipAugment() {
TableColumn col = getTableColumnAncestor();
return (col != null) ? col.getSortToolTipAugment(isDescending()) : ""; //NOI18N
}
/**
* Helper method to get the total number of selected rows.
*
* @return The number of selected rows.
*/
private int getSelectedRowsCount() {
if (selectedRowsCount == -1) {
TableRowGroup group = getTableRowGroupAncestor();
if (group != null) {
selectedRowsCount = group.getRenderedSelectedRowsCount();
}
}
return selectedRowsCount;
}
/**
* Helper method to get Theme objects.
*
* @return The current theme.
*/
private Theme getTheme() {
return ThemeUtilities.getTheme(getFacesContext());
}
/**
* Helper method to test if the next sort order is descending.
*
* @return true if descending, else false.
*/
private boolean isDescending() {
if (!descending_set) {
TableColumn col = getTableColumnAncestor();
TableRowGroup group = getTableRowGroupAncestor();
// Get next sort order.
if (col != null && group != null) {
descending = (getSortLevel() > 0)
? group.isDescendingSort(col.getSortCriteria())
: col.isDescending();
descending_set = true;
}
}
return descending;
}
/**
* 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
}
}
}