Top Description Inners Fields Constructors Methods
jakarta.faces.component.html

public Class HtmlColumn

extends UIColumn
Class Inheritance
Imports
java.util.ArrayList, .List, jakarta.el.ValueExpression, jakarta.faces.component.UIColumn

Represents a column that will be rendered in an HTML table element.

Nested and Inner Type Summary

Modifier and TypeClass and Description
protected static enum
HtmlColumn.PropertyKeys

The property keys.

Field Summary

Modifier and TypeField and Description
public static final String
COMPONENT_TYPE

Hides jakarta.faces.component.UIColumn.COMPONENT_TYPE.

The standard component type for this component.

private static final String
OPTIMIZED_PACKAGE

Inherited from jakarta.faces.component.UIColumn:
COMPONENT_FAMILY

Constructor Summary

AccessConstructor and Description
public
HtmlColumn()

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the property value

Contents: Space-separated list of CSS style class(es) that will be applied to any footer generated for this column.

getFooterClass()

Return the value of the footerClass property.

public String

Returns:

the property value

Contents: Space-separated list of CSS style class(es) that will be applied to any header generated for this column.

getHeaderClass()

Return the value of the headerClass property.

public String

Returns:

the property value

Contents: Space-separated list of CSS style class(es) that will be applied to the "td" of this column

getStyleClass()

Return the value of the styleClass property.

private void
handleAttribute(String name, Object value)

public boolean

Returns:

the property value

Contents: Flag indicating that this column is a row header column and therefore cells in this column should be rendered with "th" instead of "td" and must have the 'scope="row"' attribute.

isRowHeader()

Return the value of the rowHeader property.

public void
setFooterClass(String
the new property value
footerClass)

Set the value of the footerClass property.

public void
setHeaderClass(String
the new property value
headerClass)

Set the value of the headerClass property.

public void
setRowHeader(boolean
the new property value
rowHeader)

Set the value of the rowHeader property.

public void
setStyleClass(String
the new property value
styleClass)

Set the value of the styleClass property.

Inherited from jakarta.faces.component.UIColumn:
getFamilygetFootergetHeadersetFootersetHeader

Field Detail

COMPONENT_TYPEback to summary
public static final String COMPONENT_TYPE

Hides jakarta.faces.component.UIColumn.COMPONENT_TYPE.

The standard component type for this component.

OPTIMIZED_PACKAGEback to summary
private static final String OPTIMIZED_PACKAGE

Constructor Detail

HtmlColumnback to summary
public HtmlColumn()

Method Detail

getFooterClassback to summary
public String getFooterClass()

Return the value of the footerClass property.

Returns:String

the property value

Contents: Space-separated list of CSS style class(es) that will be applied to any footer generated for this column.

getHeaderClassback to summary
public String getHeaderClass()

Return the value of the headerClass property.

Returns:String

the property value

Contents: Space-separated list of CSS style class(es) that will be applied to any header generated for this column.

getStyleClassback to summary
public String getStyleClass()

Return the value of the styleClass property.

Returns:String

the property value

Contents: Space-separated list of CSS style class(es) that will be applied to the "td" of this column

handleAttributeback to summary
private void handleAttribute(String name, Object value)
isRowHeaderback to summary
public boolean isRowHeader()

Return the value of the rowHeader property.

Returns:boolean

the property value

Contents: Flag indicating that this column is a row header column and therefore cells in this column should be rendered with "th" instead of "td" and must have the 'scope="row"' attribute.

setFooterClassback to summary
public void setFooterClass(String footerClass)

Set the value of the footerClass property.

Parameters
footerClass:String

the new property value

setHeaderClassback to summary
public void setHeaderClass(String headerClass)

Set the value of the headerClass property.

Parameters
headerClass:String

the new property value

setRowHeaderback to summary
public void setRowHeader(boolean rowHeader)

Set the value of the rowHeader property.

Parameters
rowHeader:boolean

the new property value

setStyleClassback to summary
public void setStyleClass(String styleClass)

Set the value of the styleClass property.

Parameters
styleClass:String

the new property value

jakarta.faces.component.html back to summary

protected final Enum HtmlColumn.PropertyKeys

extends Enum<HtmlColumn.PropertyKeys>
Class Inheritance
The property keys.

Field Summary

Modifier and TypeField and Description
public static final HtmlColumn.PropertyKeys
footerClass

public static final HtmlColumn.PropertyKeys
headerClass

public static final HtmlColumn.PropertyKeys
rowHeader

public static final HtmlColumn.PropertyKeys
styleClass

pack-priv String
toString

Constructor Summary

AccessConstructor and Description
private
PropertyKeys(String toString)

private
PropertyKeys()

Method Summary

Modifier and TypeMethod and Description
public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.
public static HtmlColumn.PropertyKeys
valueOf(String name)

public static HtmlColumn.PropertyKeys[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

footerClassback to summary
public static final HtmlColumn.PropertyKeys footerClass
headerClassback to summary
public static final HtmlColumn.PropertyKeys headerClass
rowHeaderback to summary
public static final HtmlColumn.PropertyKeys rowHeader
styleClassback to summary
public static final HtmlColumn.PropertyKeys styleClass
toStringback to summary
pack-priv String toString

Constructor Detail

PropertyKeysback to summary
private PropertyKeys(String toString)
PropertyKeysback to summary
private PropertyKeys()

Method Detail

toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static HtmlColumn.PropertyKeys valueOf(String name)
valuesback to summary
public static HtmlColumn.PropertyKeys[] values()