Package com.helger.html.hc.html.grouping

Class AbstractHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

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

com.helger.html.hc.html.AbstractHCElementWithInternalChildren<IMPLTYPE,ITEMTYPE>

com.helger.html.hc.html.grouping.AbstractHCList<IMPLTYPE,ITEMTYPE>

Type Parameters:

IMPLTYPE - The real implementation type.

ITEMTYPE - The item 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>, IHCList<IMPLTYPE,ITEMTYPE>, IHCElement<IMPLTYPE>, IHCElementWithInternalChildren<IMPLTYPE,ITEMTYPE>, IHCHasCSSClasses<IMPLTYPE>, IHCHasCSSStyles<IMPLTYPE>, IHCHasChildrenMutable<IMPLTYPE,ITEMTYPE>, IHCHasID<IMPLTYPE>, IHCNode, Serializable

Direct Known Subclasses:

AbstractHCListLI, AbstractHCOLBase, AbstractHCULBase, HCMenu

public abstract class AbstractHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>
extends AbstractHCElementWithInternalChildren<IMPLTYPE,ITEMTYPE>
implements IHCList<IMPLTYPE,ITEMTYPE>

Abstract base class for UL and OL elements.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

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	AbstractHCList(EHTMLElement eElement, Class<ITEMTYPE> aItemClass)

Method Summary

Modifier and Type	Method	Description
ITEMTYPE	addAndReturnItem(IHCNode aChild)
ITEMTYPE	addAndReturnItem(IHCNode... aChildren)
ITEMTYPE	addAndReturnItem(ITEMTYPE aItem)
ITEMTYPE	addAndReturnItem(Iterable<? extends IHCNode> aChildren)
ITEMTYPE	addAndReturnItem(String sChild)
ITEMTYPE	addAndReturnItem(String... aChildren)
ITEMTYPE	addItem()
IMPLTYPE	addItem(IHCNode aChild)
IMPLTYPE	addItem(IHCNode... aChildren)
IMPLTYPE	addItem(ITEMTYPE aItem)
IMPLTYPE	addItem(Iterable<? extends IHCNode> aChildren)
IMPLTYPE	addItem(String sChild)
IMPLTYPE	addItem(String... aChildren)
protected abstract ITEMTYPE	createEmptyItem()
ITEMTYPE	getFirstItem()
ITEMTYPE	getLastItem()
protected void	onAddItem(ITEMTYPE aItem)	Callback method to be implemented in derived classes.

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

addChild, addChildAt, afterAddChild, afterRemoveChild, beforeAddChild, canConvertToMicroNode, children, fillMicroElement, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getAllChildrenAsNodeList, getChildAtIndex, getChildCount, getChildren, getChildrenFormEmitting, getFirstChild, getLastChild, getPlainText, hasChildren, removeAllChildren, removeChild, removeChildAt, sortAllChildren, toString

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

addClass, addEventHandler, addStyle, containsClass, containsEventHandler, containsStyle, createMicroElement, customAttrs, 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, onConsistencyCheck, 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, 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

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.IHCElementWithInternalChildren

recursiveContainsChildWithTagName

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

addAndReturnChild, addAndReturnChildAt, addChild, addChildAt, addChildren, addChildren, addChildren, addChildrenAt, addChildrenAt, getAllChildrenAsNodeList, removeAllChildren, removeChild, removeChildAt, setChild, sortAllChildren

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

Constructor Detail

AbstractHCList

protected AbstractHCList(@Nonnull
                         EHTMLElement eElement,
                         @Nonnull
                         Class<ITEMTYPE> aItemClass)

Method Detail

onAddItem

@OverrideOnDemand
protected void onAddItem(@Nonnull
                         ITEMTYPE aItem)

Callback method to be implemented in derived classes. Called every time after an item was added.

Parameters:

aItem - The added item. Never null.

createEmptyItem

@Nonnull
protected abstract ITEMTYPE createEmptyItem()

addItem

@Nonnull
public final ITEMTYPE addItem()

Specified by:

addItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addAndReturnItem

@Nonnull
@CheckReturnValue
public final ITEMTYPE addAndReturnItem(@Nullable
                                       String sChild)

Specified by:

addAndReturnItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addAndReturnItem

@Nonnull
@CheckReturnValue
public final ITEMTYPE addAndReturnItem(@Nullable
                                       String... aChildren)

Specified by:

addAndReturnItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addAndReturnItem

@Nonnull
@CheckReturnValue
public final ITEMTYPE addAndReturnItem(@Nullable
                                       IHCNode aChild)

Specified by:

addAndReturnItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addAndReturnItem

@Nonnull
@CheckReturnValue
public final ITEMTYPE addAndReturnItem(@Nullable
                                       IHCNode... aChildren)

Specified by:

addAndReturnItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addAndReturnItem

@Nonnull
@CheckReturnValue
public final ITEMTYPE addAndReturnItem(@Nullable
                                       Iterable<? extends IHCNode> aChildren)

Specified by:

addAndReturnItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addAndReturnItem

@Nullable
@CheckReturnValue
public final ITEMTYPE addAndReturnItem(@Nullable
                                       ITEMTYPE aItem)

Specified by:

addAndReturnItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addItem

@Nonnull
public final IMPLTYPE addItem(@Nullable
                              String sChild)

Specified by:

addItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addItem

@Nonnull
public final IMPLTYPE addItem(@Nullable
                              String... aChildren)

Specified by:

addItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addItem

@Nonnull
public final IMPLTYPE addItem(@Nullable
                              IHCNode aChild)

Specified by:

addItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addItem

@Nonnull
public final IMPLTYPE addItem(@Nullable
                              IHCNode... aChildren)

Specified by:

addItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addItem

@Nonnull
public final IMPLTYPE addItem(@Nullable
                              Iterable<? extends IHCNode> aChildren)

Specified by:

addItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

addItem

@Nonnull
public final IMPLTYPE addItem(@Nullable
                              ITEMTYPE aItem)

Specified by:

addItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

getFirstItem

@Nullable
public final ITEMTYPE getFirstItem()

Specified by:

getFirstItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>

getLastItem

@Nullable
public final ITEMTYPE getLastItem()

Specified by:

getLastItem in interface IHCList<IMPLTYPE extends AbstractHCList<IMPLTYPE,ITEMTYPE>,ITEMTYPE extends IHCLI<ITEMTYPE>>