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

Class AbstractHCBaseTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

com.helger.html.hc.html.AbstractHCElement<IMPLTYPE>

com.helger.html.hc.html.tabular.AbstractHCBaseTable<IMPLTYPE>

Type Parameters:

IMPLTYPE - Implementation type

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractHCTable

public abstract class AbstractHCBaseTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>
extends AbstractHCElement<IMPLTYPE>
implements IHCTable<IMPLTYPE>

This is the common base class for regular HC tables as well as for more complex constructs (e.g. PUI)

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ICSSClassProvider	CSS_FORCE_COLSPAN

Fields inherited from class com.helger.html.hc.html.AbstractHCElement

DEFAULT_HIDDEN, DEFAULT_SPELLCHECK, DEFAULT_TRANSLATE, DEFAULT_UNFOCUSABLE

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

DEFAULT_TABINDEX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractHCBaseTable(EHTMLElement aElement)	This constructor is used to create elements with logic like a table but actually not having a top 'table' element

Method Summary

Modifier and Type	Method	Description
IMPLTYPE	addColumn(IHCCol<?> aCol)	Add the specified column.
IMPLTYPE	addColumnAt(int nIndex, IHCCol<?> aCol)	Add the specified column at the specified index.
boolean	canConvertToMicroNode(IHCConversionSettingsToNode aConversionSettings)	This method checks whether the node is suitable for conversion to an IMicroNode.
void	checkInternalConsistency()
void	forAllChildren(Consumer<? super IHCNode> aConsumer)
void	forAllChildren(Predicate<? super IHCNode> aFilter, Consumer<? super IHCNode> aConsumer)
com.helger.commons.state.EContinue	forAllChildrenBreakable(Function<? super IHCNode,com.helger.commons.state.EContinue> aConsumer)
<DSTTYPE> void	forAllChildrenMapped(Predicate<? super IHCNode> aFilter, Function<? super IHCNode,? extends DSTTYPE> aMapper, Consumer<? super DSTTYPE> aConsumer)
com.helger.commons.collection.impl.ICommonsList<IHCNode>	getAllChildren()
HCTBody	getBody()
int	getCellPadding()
int	getCellSpacing()
IHCNode	getChildAtIndex(int nIndex)
int	getChildCount()
com.helger.commons.collection.impl.ICommonsIterable<? extends IHCNode>	getChildren()
HCColGroup	getColGroup()
int	getColumnCount()
IHCNode	getFirstChild()
HCTFoot	getFoot()
HCTHead	getHead()
IHCNode	getLastChild()
String	getPlainText()
boolean	hasChildren()
protected void	onConsistencyCheck(IHCConversionSettingsToNode aConversionSettings)
IMPLTYPE	removeAllColumns()	Remove all column definitions.
IMPLTYPE	removeColumnAt(int nColumnIndex)	Remove the column definition at the specified index.
IMPLTYPE	setBody(HCTBody aBody)
IMPLTYPE	setCellPadding(int nCellPadding)	Set the cell padding.
IMPLTYPE	setCellSpacing(int nCellSpacing)	Set the cell spacing.
IMPLTYPE	setFoot(HCTFoot aFoot)
IMPLTYPE	setHead(HCTHead aHead)
String	toString()

Methods inherited from class com.helger.html.hc.html.AbstractHCElement

addClass, addEventHandler, addStyle, containsClass, containsEventHandler, containsStyle, createMicroElement, customAttrs, fillMicroElement, finishMicroElement, getAccessKey, getAllClasses, getAllClassesAsString, getAllClassNames, getAllStyles, getAllStylesAsString, getAllStyleValues, getContentEditable, getDirection, getDraggable, getElement, getEventHandler, getEventMap, getID, getLanguage, getRole, getStyleValue, getTabIndex, getTagName, getTitle, getTranslate, hasAnyClass, hasAnyStyle, hasStyle, internalConvertToMicroNode, isHidden, isSpellCheck, isTranslateOff, isTranslateOn, isTranslateUndefined, isUnfocusable, isValidID, onFinalizeNodeState, prependEventHandler, removeAllClasses, removeAllEventHandler, removeAllStyles, removeClass, removeStyle, setAccessKey, setContentEditable, setDirection, setDraggable, setEventHandler, setHidden, setID, setID, setLanguage, setRole, setSpellCheck, setTabIndex, setTitle, setTranslate, setUnfocusable

Methods inherited from class com.helger.html.hc.impl.AbstractHCNode

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, findFirstChild, findFirstChildMapped, getNodeState, internalSetNodeState, onCustomizeNode, onRegisterExternalResources, registerExternalResources

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

thisAsT

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

hasNoChildren

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

forAllChildrenRecursive, forAllChildrenRecursive

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

findFirstChild, findFirstChildMapped

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

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, registerExternalResources

Methods inherited from interface com.helger.html.hc.html.tabular.IHCTable

addBodyClass, addBodyRow, addBodyRow, addBodyRowAt, addBodyRowAt, addColumns, addColumns, addColumns, addFooterClass, addFooterRow, addFooterRow, addFooterRowAt, addFooterRowAt, addHeaderClass, addHeaderRow, addHeaderRow, addHeaderRowAt, addHeaderRowAt, addSpanningBodyContent, addSpanningBodyContent, addSpanningFooterContent, addSpanningFooterContent, addSpanningHeaderContent, addSpanningHeaderContent, getAllBodyClasses, getAllBodyClassesAsString, getAllBodyRows, getAllColumns, getAllFooterClasses, getAllFooterClassesAsString, getAllFooterRows, getAllHeaderClasses, getAllHeaderClassesAsString, getAllHeaderRows, getBodyID, getBodyRowAtIndex, getBodyRowCount, getFirstBodyRow, getFirstFooterRow, getFirstHeaderRow, getFooterID, getFooterRowAtIndex, getFooterRowCount, getHeaderID, getHeaderRowAtIndex, getHeaderRowCount, getLastBodyRow, getLastFooterRow, getLastHeaderRow, hasBodyClasses, hasBodyID, hasBodyRows, hasFooterClasses, hasFooterID, hasFooterRows, hasHeaderClasses, hasHeaderID, hasHeaderRows, removeAllBodyRows, removeAllFooterRows, removeAllHeaderRows, removeBodyClass, removeBodyRowAt, removeFooterClass, removeFooterRowAt, removeHeaderClass, removeHeaderRowAt, setBodyID, setFooterID, setHeaderID, setSpanningFooterContent, setSpanningFooterContent, setSpanningHeaderContent, setSpanningHeaderContent, sortAllBodyRows, sortAllFooterRows, sortAllHeaderRows

Field Detail

CSS_FORCE_COLSPAN

public static final ICSSClassProvider CSS_FORCE_COLSPAN

Constructor Detail

AbstractHCBaseTable

protected AbstractHCBaseTable(@Nonnull @Nonempty
                              EHTMLElement aElement)

This constructor is used to create elements with logic like a table but actually not having a top 'table' element

Parameters:

aElement - The HTML element to be used to create the table

Method Detail

getHead

@Nonnull
public final HCTHead getHead()

Specified by:

getHead in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Returns:

The table header. Never null.

setHead

@Nonnull
public final IMPLTYPE setHead(@Nonnull
                              HCTHead aHead)

Specified by:

setHead in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

getBody

@Nonnull
public final HCTBody getBody()

Specified by:

getBody in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Returns:

The table body. Never null.

setBody

@Nonnull
public final IMPLTYPE setBody(@Nonnull
                              HCTBody aBody)

Specified by:

setBody in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

getFoot

@Nonnull
public final HCTFoot getFoot()

Specified by:

getFoot in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Returns:

The table footer. Never null.

setFoot

@Nonnull
public final IMPLTYPE setFoot(@Nonnull
                              HCTFoot aFoot)

Specified by:

setFoot in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

hasChildren

public final boolean hasChildren()

Specified by:

hasChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

hasChildren in class AbstractHCNode

getChildCount

@Nonnegative
public final int getChildCount()

Specified by:

getChildCount in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

getChildCount in class AbstractHCNode

getFirstChild

@Nullable
public final IHCNode getFirstChild()

Specified by:

getFirstChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

getFirstChild in class AbstractHCNode

getLastChild

@Nullable
public final IHCNode getLastChild()

Specified by:

getLastChild in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

getLastChild in class AbstractHCNode

getAllChildren

@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<IHCNode> getAllChildren()

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Specified by:

getAllChildren in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

getAllChildren in class AbstractHCNode

getChildren

@Nonnull
public com.helger.commons.collection.impl.ICommonsIterable<? extends IHCNode> getChildren()

Specified by:

getChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

getChildren in class AbstractHCNode

getChildAtIndex

@Nullable
public final IHCNode getChildAtIndex(@Nonnegative
                                     int nIndex)

Specified by:

getChildAtIndex in interface com.helger.commons.hierarchy.IHasChildrenSorted<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

getChildAtIndex in class AbstractHCNode

getCellSpacing

@CheckForSigned
public final int getCellSpacing()

Specified by:

getCellSpacing in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Returns:

The cell spacing. Values ≤ 0 mean undefined.

setCellSpacing

@Nonnull
public final IMPLTYPE setCellSpacing(int nCellSpacing)

Description copied from interface: IHCTable

Set the cell spacing.

Specified by:

setCellSpacing in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Parameters:

nCellSpacing - New value. Values ≤ 0 mean undefined.

Returns:

this

getCellPadding

@CheckForSigned
public final int getCellPadding()

Specified by:

getCellPadding in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Returns:

The cell padding. Values ≤ 0 mean undefined.

setCellPadding

@Nonnull
public final IMPLTYPE setCellPadding(int nCellPadding)

Description copied from interface: IHCTable

Set the cell padding.

Specified by:

setCellPadding in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Parameters:

nCellPadding - New value. Values ≤ 0 mean undefined.

Returns:

this

getColGroup

@Nullable
public final HCColGroup getColGroup()

Specified by:

getColGroup in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Returns:

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

addColumn

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

Description copied from interface: IHCTable

Add the specified column.

Specified by:

addColumn in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Parameters:

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

Returns:

this

addColumnAt

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

Description copied from interface: IHCTable

Add the specified column at the specified index.

Specified by:

addColumnAt in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Parameters:

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

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

Returns:

this

removeColumnAt

@Nonnull
public final IMPLTYPE removeColumnAt(@Nonnegative
                                     int nColumnIndex)

Description copied from interface: IHCTable

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

Specified by:

removeColumnAt in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Parameters:

nColumnIndex - The index of the column to remove

Returns:

this

removeAllColumns

@Nonnull
public final IMPLTYPE removeAllColumns()

Description copied from interface: IHCTable

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

Specified by:

removeAllColumns in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Returns:

this

getColumnCount

@Nonnegative
public final int getColumnCount()

Specified by:

getColumnCount in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Returns:

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

canConvertToMicroNode

@OverridingMethodsMustInvokeSuper
public boolean canConvertToMicroNode(@Nonnull
                                     IHCConversionSettingsToNode aConversionSettings)

Description copied from interface: IHCNode

This method checks whether the node is suitable for conversion to an IMicroNode. If this node cannot be converted, no child node will be converted as well!

Specified by:

canConvertToMicroNode in interface IHCNode

Overrides:

canConvertToMicroNode in class AbstractHCNode

Parameters:

aConversionSettings - The conversion settings to be used

Returns:

true if the node can be converted to a node, false otherwise.

checkInternalConsistency

public void checkInternalConsistency()

Specified by:

checkInternalConsistency in interface IHCTable<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

onConsistencyCheck

protected void onConsistencyCheck(@Nonnull
                                  IHCConversionSettingsToNode aConversionSettings)

Overrides:

onConsistencyCheck in class AbstractHCElement<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Parameters:

aConversionSettings - HC conversion settings

getPlainText

@Nonnull
public final String getPlainText()

Specified by:

getPlainText in interface IHCNode

Overrides:

getPlainText in class AbstractHCNode

Returns:

The plain text representation of this text. May not be null.

forAllChildren

public final void forAllChildren(@Nonnull
                                 Consumer<? super IHCNode> aConsumer)

Specified by:

forAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

forAllChildren in class AbstractHCNode

forAllChildrenBreakable

@Nonnull
public final com.helger.commons.state.EContinue forAllChildrenBreakable(@Nonnull
                                                                        Function<? super IHCNode,com.helger.commons.state.EContinue> aConsumer)

Specified by:

forAllChildrenBreakable in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

forAllChildrenBreakable in class AbstractHCNode

forAllChildren

public final void forAllChildren(@Nonnull
                                 Predicate<? super IHCNode> aFilter,
                                 @Nonnull
                                 Consumer<? super IHCNode> aConsumer)

Specified by:

forAllChildren in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

forAllChildren in class AbstractHCNode

forAllChildrenMapped

public <DSTTYPE> void forAllChildrenMapped(@Nonnull
                                           Predicate<? super IHCNode> aFilter,
                                           @Nonnull
                                           Function<? super IHCNode,? extends DSTTYPE> aMapper,
                                           @Nonnull
                                           Consumer<? super DSTTYPE> aConsumer)

Specified by:

forAllChildrenMapped in interface com.helger.commons.hierarchy.IHasChildren<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>

Overrides:

forAllChildrenMapped in class AbstractHCNode

toString

public String toString()

Overrides:

toString in class AbstractHCElement<IMPLTYPE extends AbstractHCBaseTable<IMPLTYPE>>