Package com.helger.html.hc.html.tabular

Interface IHCTable<IMPLTYPE extends IHCTable<IMPLTYPE>>

Type Parameters:

IMPLTYPE - Implementation type

All Superinterfaces:

com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>, com.helger.commons.hierarchy.IHasChildren<IHCNode>, com.helger.commons.hierarchy.IHasChildrenRecursive<IHCNode>, com.helger.commons.hierarchy.IHasChildrenSorted<IHCNode>, IHCElement<IMPLTYPE>, IHCHasCSSClasses<IMPLTYPE>, IHCHasCSSStyles<IMPLTYPE>, IHCHasID<IMPLTYPE>, IHCNode, Serializable

All Known Implementing Classes:

AbstractHCBaseTable, AbstractHCTable, HCTable

public interface IHCTable<IMPLTYPE extends IHCTable<IMPLTYPE>>
extends IHCElement<IMPLTYPE>

Base interface for HTML tables

Author:

Philip Helger

Field Summary

Fields inherited from interface com.helger.html.hc.html.IHCElement

DEFAULT_TABINDEX

Method Summary

Modifier and Type	Method	Description
default IMPLTYPE	addBodyClass(ICSSClassProvider aCSSClassProvider)
default HCRow	addBodyRow()
default IMPLTYPE	addBodyRow(HCRow aRow)
default HCRow	addBodyRowAt(int nIndex)	Add a body row at the specified index.
default IMPLTYPE	addBodyRowAt(int nIndex, HCRow aRow)	Add a body row at the specified index.
IMPLTYPE	addColumn(IHCCol<?> aCol)	Add the specified column.
IMPLTYPE	addColumnAt(int nIndex, IHCCol<?> aCol)	Add the specified column at the specified index.
default IMPLTYPE	addColumns(IHCCol<?> aCol)	Deprecated. Use addColumn instead.
default IMPLTYPE	addColumns(IHCCol<?>... aCols)	Add multiple columns at once.
default IMPLTYPE	addColumns(Iterable<? extends IHCCol<?>> aCols)	Add multiple columns at once.
default IMPLTYPE	addFooterClass(ICSSClassProvider aCSSClassProvider)
default HCRow	addFooterRow()
default IMPLTYPE	addFooterRow(HCRow aRow)
default HCRow	addFooterRowAt(int nIndex)	Add a footer row at the specified index.
default IMPLTYPE	addFooterRowAt(int nIndex, HCRow aRow)	Add a footer row at the specified index.
default IMPLTYPE	addHeaderClass(ICSSClassProvider aCSSClassProvider)
default HCRow	addHeaderRow()
default IMPLTYPE	addHeaderRow(HCRow aRow)
default HCRow	addHeaderRowAt(int nIndex)	Add a header row at the specified index.
default IMPLTYPE	addHeaderRowAt(int nIndex, HCRow aRow)	Add a header row at the specified index.
default IMPLTYPE	addSpanningBodyContent(IHCNode aNode)
default IMPLTYPE	addSpanningBodyContent(String sText)
default IMPLTYPE	addSpanningFooterContent(IHCNode aNode)
default IMPLTYPE	addSpanningFooterContent(String sText)
default IMPLTYPE	addSpanningHeaderContent(IHCNode aNode)
default IMPLTYPE	addSpanningHeaderContent(String sText)
void	checkInternalConsistency()
default com.helger.commons.collection.impl.ICommonsSet<ICSSClassProvider>	getAllBodyClasses()
default String	getAllBodyClassesAsString()
default com.helger.commons.collection.impl.ICommonsList<HCRow>	getAllBodyRows()
default com.helger.commons.collection.impl.ICommonsList<? extends IHCCol<?>>	getAllColumns()
default com.helger.commons.collection.impl.ICommonsSet<ICSSClassProvider>	getAllFooterClasses()
default String	getAllFooterClassesAsString()
default com.helger.commons.collection.impl.ICommonsList<HCRow>	getAllFooterRows()
default com.helger.commons.collection.impl.ICommonsSet<ICSSClassProvider>	getAllHeaderClasses()
default String	getAllHeaderClassesAsString()
default com.helger.commons.collection.impl.ICommonsList<HCRow>	getAllHeaderRows()
HCTBody	getBody()
default String	getBodyID()
default HCRow	getBodyRowAtIndex(int nIndex)
default int	getBodyRowCount()
int	getCellPadding()
int	getCellSpacing()
HCColGroup	getColGroup()
int	getColumnCount()
default HCRow	getFirstBodyRow()
default HCRow	getFirstFooterRow()
default HCRow	getFirstHeaderRow()
HCTFoot	getFoot()
default String	getFooterID()
default HCRow	getFooterRowAtIndex(int nIndex)
default int	getFooterRowCount()
HCTHead	getHead()
default String	getHeaderID()
default HCRow	getHeaderRowAtIndex(int nIndex)
default int	getHeaderRowCount()
default HCRow	getLastBodyRow()
default HCRow	getLastFooterRow()
default HCRow	getLastHeaderRow()
default boolean	hasBodyClasses()
default boolean	hasBodyID()
default boolean	hasBodyRows()
default boolean	hasFooterClasses()
default boolean	hasFooterID()
default boolean	hasFooterRows()
default boolean	hasHeaderClasses()
default boolean	hasHeaderID()
default boolean	hasHeaderRows()
default IMPLTYPE	removeAllBodyRows()
IMPLTYPE	removeAllColumns()	Remove all column definitions.
default IMPLTYPE	removeAllFooterRows()
default IMPLTYPE	removeAllHeaderRows()
default IMPLTYPE	removeBodyClass(ICSSClassProvider aCSSClassProvider)
default IMPLTYPE	removeBodyRowAt(int nIndex)	Remove the body row at the specified index.
IMPLTYPE	removeColumnAt(int nColumnIndex)	Remove the column definition at the specified index.
default IMPLTYPE	removeFooterClass(ICSSClassProvider aCSSClassProvider)
default IMPLTYPE	removeFooterRowAt(int nIndex)	Remove a footer row at the specified index.
default IMPLTYPE	removeHeaderClass(ICSSClassProvider aCSSClassProvider)
default IMPLTYPE	removeHeaderRowAt(int nIndex)	Remove the header row at the specified index.
IMPLTYPE	setBody(HCTBody aBody)
default IMPLTYPE	setBodyID(String sID)
IMPLTYPE	setCellPadding(int nCellPadding)	Set the cell padding.
IMPLTYPE	setCellSpacing(int nCellSpacing)	Set the cell spacing.
IMPLTYPE	setFoot(HCTFoot aFoot)
default IMPLTYPE	setFooterID(String sID)
IMPLTYPE	setHead(HCTHead aHead)
default IMPLTYPE	setHeaderID(String sID)	Set the ID of the table head.
default IMPLTYPE	setSpanningFooterContent(IHCNode aNode)
default IMPLTYPE	setSpanningFooterContent(String sText)
default IMPLTYPE	setSpanningHeaderContent(IHCNode aNode)
default IMPLTYPE	setSpanningHeaderContent(String sText)
default IMPLTYPE	sortAllBodyRows(Comparator<? super HCRow> aComparator)
default IMPLTYPE	sortAllFooterRows(Comparator<? super HCRow> aComparator)
default IMPLTYPE	sortAllHeaderRows(Comparator<? super HCRow> aComparator)

Methods inherited from interface com.helger.commons.traits.IGenericImplTrait

thisAsT

Methods inherited from interface com.helger.commons.hierarchy.IHasChildren

forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getChildCount, getChildren, hasChildren, hasNoChildren

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenRecursive

forAllChildrenRecursive, forAllChildrenRecursive

Methods inherited from interface com.helger.commons.hierarchy.IHasChildrenSorted

findFirstChild, findFirstChildMapped, getAllChildren, getChildAtIndex, getFirstChild, getLastChild

Methods inherited from interface com.helger.html.hc.html.IHCElement

addEventHandler, containsEventHandler, customAttrs, getAccessKey, getContentEditable, getDirection, getDraggable, getElement, getEventHandler, getEventMap, getLanguage, getRole, getTabIndex, getTagName, getTitle, getTranslate, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, prependEventHandler, removeAllEventHandler, setAccessKey, setContentEditable, setDirection, setDraggable, setEventHandler, setHidden, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setTranslate, setUnfocusable, withCustomAttrs

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSClasses

addClass, addClasses, addClasses, addClasses, containsClass, getAllClasses, getAllClassesAsString, getAllClassNames, hasAnyClass, removeAllClasses, removeClass

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSStyles

addStyle, addStyle, addStyles, addStyles, addStyles, containsStyle, getAllStyles, getAllStylesAsString, getAllStyleValues, getStyleValue, hasAnyStyle, hasStyle, removeAllStyles, removeStyle

Methods inherited from interface com.helger.html.hc.IHCHasID

ensureID, getID, hasID, hasNoID, setID, setUniqueID

Methods inherited from interface com.helger.html.hc.IHCNode

canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, getPlainText, registerExternalResources

Method Detail

getHead

@Nonnull
HCTHead getHead()

Returns:

The table header. Never null.

setHead

@Nonnull
IMPLTYPE setHead(@Nonnull
                 HCTHead aHead)

getBody

@Nonnull
HCTBody getBody()

Returns:

The table body. Never null.

setBody

@Nonnull
IMPLTYPE setBody(@Nonnull
                 HCTBody aBody)

getFoot

@Nonnull
HCTFoot getFoot()

Returns:

The table footer. Never null.

setFoot

@Nonnull
IMPLTYPE setFoot(@Nonnull
                 HCTFoot aFoot)

getCellSpacing

@CheckForSigned
int getCellSpacing()

Returns:

The cell spacing. Values ≤ 0 mean undefined.

setCellSpacing

@Nonnull
IMPLTYPE setCellSpacing(int nCellSpacing)

Set the cell spacing.

Parameters:

nCellSpacing - New value. Values ≤ 0 mean undefined.

Returns:

this

getCellPadding

@CheckForSigned
int getCellPadding()

Returns:

The cell padding. Values ≤ 0 mean undefined.

setCellPadding

@Nonnull
IMPLTYPE setCellPadding(int nCellPadding)

Set the cell padding.

Parameters:

nCellPadding - New value. Values ≤ 0 mean undefined.

Returns:

this

getColGroup

@Nullable
HCColGroup getColGroup()

Returns:

The column group used for this table. May be null if undefined.

getAllColumns

@Nonnull
@ReturnsMutableCopy
default com.helger.commons.collection.impl.ICommonsList<? extends IHCCol<?>> getAllColumns()

addColumn

@Nonnull
IMPLTYPE addColumn(@Nullable
                   IHCCol<?> aCol)

Add the specified column.

Parameters:

aCol - The column to be added. May be null.

Returns:

this

addColumnAt

@Nonnull
IMPLTYPE addColumnAt(@Nonnegative
                     int nIndex,
                     @Nullable
                     IHCCol<?> aCol)

Add the specified column at the specified index.

Parameters:

nIndex - The index where the column should be added. Must be ≥ 0.

aCol - The column to be added. May be null.

Returns:

this

addColumns

@Nonnull
@Deprecated(forRemoval=false)
@DevelopersNote("Use addColumn")
default IMPLTYPE addColumns(@Nullable
                            IHCCol<?> aCol)

Deprecated.

Use addColumn instead.

Add a single column.

Parameters:

aCol - The column to be added. May be null.

Returns:

this

addColumns

@Nonnull
default IMPLTYPE addColumns(@Nullable
                            IHCCol<?>... aCols)

Add multiple columns at once.

Parameters:

aCols - The columns to be added. May be null and may contain null elements.

Returns:

this

addColumns

@Nonnull
default IMPLTYPE addColumns(@Nullable
                            Iterable<? extends IHCCol<?>> aCols)

Add multiple columns at once.

Parameters:

aCols - The columns to be added. May be null and may contain null elements.

Returns:

this

removeColumnAt

@Nonnull
IMPLTYPE removeColumnAt(@Nonnegative
                        int nColumnIndex)

Remove the column definition at the specified index. This does not affect any row contents.

Parameters:

nColumnIndex - The index of the column to remove

Returns:

this

removeAllColumns

@Nonnull
IMPLTYPE removeAllColumns()

Remove all column definitions. This does not affect any row contents.

Returns:

this

getColumnCount

@Nonnegative
int getColumnCount()

Returns:

The number of columns as specified in the column group. If no column group is defined, 0 is returned.

getHeaderID

@Nullable
default String getHeaderID()

Returns:

The ID of the table head. May be null.

setHeaderID

@Nonnull
default IMPLTYPE setHeaderID(@Nullable
                             String sID)

Set the ID of the table head.

Parameters:

sID - The table head ID. May be null-

Returns:

this

hasHeaderID

default boolean hasHeaderID()

Returns:

true if a table header ID is present, false otherwise

getAllHeaderClasses

@Nonnull
@ReturnsMutableCopy
default com.helger.commons.collection.impl.ICommonsSet<ICSSClassProvider> getAllHeaderClasses()

getAllHeaderClassesAsString

@Nonnull
default String getAllHeaderClassesAsString()

addHeaderClass

@Nonnull
default IMPLTYPE addHeaderClass(@Nonnull
                                ICSSClassProvider aCSSClassProvider)

removeHeaderClass

@Nonnull
default IMPLTYPE removeHeaderClass(@Nonnull
                                   ICSSClassProvider aCSSClassProvider)

hasHeaderClasses

default boolean hasHeaderClasses()

hasHeaderRows

default boolean hasHeaderRows()

getHeaderRowCount

@Nonnegative
default int getHeaderRowCount()

getFirstHeaderRow

@Nullable
default HCRow getFirstHeaderRow()

getHeaderRowAtIndex

@Nullable
default HCRow getHeaderRowAtIndex(@Nonnegative
                                  int nIndex)

getLastHeaderRow

@Nullable
default HCRow getLastHeaderRow()

getAllHeaderRows

@Nonnull
@ReturnsMutableCopy
default com.helger.commons.collection.impl.ICommonsList<HCRow> getAllHeaderRows()

addHeaderRow

@Nonnull
default HCRow addHeaderRow()

addHeaderRowAt

@Nonnull
default HCRow addHeaderRowAt(@Nonnegative
                             int nIndex)

Add a header row at the specified index.

Parameters:

nIndex - The index to be used. Should be ≥ 0.

Returns:

this for chaining

addHeaderRow

@Nonnull
default IMPLTYPE addHeaderRow(@Nullable
                              HCRow aRow)

addHeaderRowAt

@Nonnull
default IMPLTYPE addHeaderRowAt(@Nonnegative
                                int nIndex,
                                @Nullable
                                HCRow aRow)

Add a header row at the specified index.

Parameters:

nIndex - The index to be used. Should be ≥ 0.

aRow - The row to be added. May be null.

Returns:

this for chaining

removeHeaderRowAt

@Nonnull
default IMPLTYPE removeHeaderRowAt(@Nonnegative
                                   int nIndex)

Remove the header row at the specified index.

Parameters:

nIndex - The index to be used. Should be ≥ 0.

Returns:

this for chaining

removeAllHeaderRows

@Nonnull
default IMPLTYPE removeAllHeaderRows()

sortAllHeaderRows

@Nonnull
default IMPLTYPE sortAllHeaderRows(@Nonnull
                                   Comparator<? super HCRow> aComparator)

getFooterID

@Nullable
default String getFooterID()

setFooterID

@Nonnull
default IMPLTYPE setFooterID(@Nullable
                             String sID)

hasFooterID

default boolean hasFooterID()

Returns:

true if a Footer ID is present, false otherwise

getAllFooterClasses

@Nonnull
@ReturnsMutableCopy
default com.helger.commons.collection.impl.ICommonsSet<ICSSClassProvider> getAllFooterClasses()

getAllFooterClassesAsString

@Nonnull
default String getAllFooterClassesAsString()

addFooterClass

@Nonnull
default IMPLTYPE addFooterClass(@Nonnull
                                ICSSClassProvider aCSSClassProvider)

removeFooterClass

@Nonnull
default IMPLTYPE removeFooterClass(@Nonnull
                                   ICSSClassProvider aCSSClassProvider)

hasFooterClasses

default boolean hasFooterClasses()

hasFooterRows

default boolean hasFooterRows()

getFooterRowCount

@Nonnegative
default int getFooterRowCount()

getFirstFooterRow

@Nullable
default HCRow getFirstFooterRow()

getFooterRowAtIndex

@Nullable
default HCRow getFooterRowAtIndex(@Nonnegative
                                  int nIndex)

getLastFooterRow

@Nullable
default HCRow getLastFooterRow()

getAllFooterRows

@Nonnull
@ReturnsMutableCopy
default com.helger.commons.collection.impl.ICommonsList<HCRow> getAllFooterRows()

addFooterRow

@Nonnull
default HCRow addFooterRow()

addFooterRowAt

@Nonnull
default HCRow addFooterRowAt(@Nonnegative
                             int nIndex)

Add a footer row at the specified index.

Parameters:

nIndex - The index to be used. Should be ≥ 0.

Returns:

this for chaining

addFooterRow

@Nonnull
default IMPLTYPE addFooterRow(@Nullable
                              HCRow aRow)

addFooterRowAt

@Nonnull
default IMPLTYPE addFooterRowAt(@Nonnegative
                                int nIndex,
                                @Nullable
                                HCRow aRow)

Add a footer row at the specified index.

Parameters:

nIndex - The index to be used. Should be ≥ 0.

aRow - The row to be added. May be null.

Returns:

this for chaining

removeFooterRowAt

@Nonnull
default IMPLTYPE removeFooterRowAt(@Nonnegative
                                   int nIndex)

Remove a footer row at the specified index.

Parameters:

nIndex - The index to be used. Should be ≥ 0.

Returns:

this for chaining

removeAllFooterRows

@Nonnull
default IMPLTYPE removeAllFooterRows()

sortAllFooterRows

@Nonnull
default IMPLTYPE sortAllFooterRows(@Nonnull
                                   Comparator<? super HCRow> aComparator)

getBodyID

@Nullable
default String getBodyID()

setBodyID

@Nonnull
default IMPLTYPE setBodyID(@Nullable
                           String sID)

hasBodyID

default boolean hasBodyID()

Returns:

true if a body ID is present, false otherwise

getAllBodyClasses

@Nonnull
@ReturnsMutableCopy
default com.helger.commons.collection.impl.ICommonsSet<ICSSClassProvider> getAllBodyClasses()

getAllBodyClassesAsString

@Nonnull
default String getAllBodyClassesAsString()

addBodyClass

@Nonnull
default IMPLTYPE addBodyClass(@Nonnull
                              ICSSClassProvider aCSSClassProvider)

removeBodyClass

@Nonnull
default IMPLTYPE removeBodyClass(@Nonnull
                                 ICSSClassProvider aCSSClassProvider)

hasBodyClasses

default boolean hasBodyClasses()

hasBodyRows

default boolean hasBodyRows()

getBodyRowCount

@Nonnegative
default int getBodyRowCount()

getFirstBodyRow

@Nullable
default HCRow getFirstBodyRow()

getBodyRowAtIndex

@Nullable
default HCRow getBodyRowAtIndex(@Nonnegative
                                int nIndex)

getLastBodyRow

@Nullable
default HCRow getLastBodyRow()

getAllBodyRows

@Nonnull
@ReturnsMutableCopy
default com.helger.commons.collection.impl.ICommonsList<HCRow> getAllBodyRows()

addBodyRow

@Nonnull
default HCRow addBodyRow()

addBodyRowAt

@Nonnull
default HCRow addBodyRowAt(@Nonnegative
                           int nIndex)

Add a body row at the specified index.

Parameters:

nIndex - The index to be used. Should be ≥ 0.

Returns:

this for chaining

addBodyRow

@Nonnull
default IMPLTYPE addBodyRow(@Nullable
                            HCRow aRow)

addBodyRowAt

@Nonnull
default IMPLTYPE addBodyRowAt(@Nonnegative
                              int nIndex,
                              @Nullable
                              HCRow aRow)

Add a body row at the specified index.

Parameters:

nIndex - The index to be used. Should be ≥ 0.

aRow - The row to be added. May be null.

Returns:

this for chaining

removeBodyRowAt

@Nonnull
default IMPLTYPE removeBodyRowAt(@Nonnegative
                                 int nIndex)

Remove the body row at the specified index.

Parameters:

nIndex - The index to be used. Should be ≥ 0.

Returns:

this for chaining

removeAllBodyRows

@Nonnull
default IMPLTYPE removeAllBodyRows()

sortAllBodyRows

@Nonnull
default IMPLTYPE sortAllBodyRows(@Nonnull
                                 Comparator<? super HCRow> aComparator)

setSpanningHeaderContent

@Nonnull
default IMPLTYPE setSpanningHeaderContent(@Nullable
                                          String sText)

setSpanningHeaderContent

@Nonnull
default IMPLTYPE setSpanningHeaderContent(@Nullable
                                          IHCNode aNode)

addSpanningHeaderContent

@Nonnull
default IMPLTYPE addSpanningHeaderContent(@Nullable
                                          String sText)

addSpanningHeaderContent

@Nonnull
default IMPLTYPE addSpanningHeaderContent(@Nullable
                                          IHCNode aNode)

addSpanningBodyContent

@Nonnull
default IMPLTYPE addSpanningBodyContent(@Nullable
                                        String sText)

addSpanningBodyContent

@Nonnull
default IMPLTYPE addSpanningBodyContent(@Nullable
                                        IHCNode aNode)

setSpanningFooterContent

@Nonnull
default IMPLTYPE setSpanningFooterContent(@Nullable
                                          String sText)

setSpanningFooterContent

@Nonnull
default IMPLTYPE setSpanningFooterContent(@Nullable
                                          IHCNode aNode)

addSpanningFooterContent

@Nonnull
default IMPLTYPE addSpanningFooterContent(@Nullable
                                          String sText)

addSpanningFooterContent

@Nonnull
default IMPLTYPE addSpanningFooterContent(@Nullable
                                          IHCNode aNode)

checkInternalConsistency

void checkInternalConsistency()