Package com.helger.html.hc

Interface IHCHasID<IMPLTYPE extends IHCHasID<IMPLTYPE>>

Type Parameters:

IMPLTYPE - The implementation type

All Superinterfaces:

com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>

All Known Subinterfaces:

IHCA<IMPLTYPE>, IHCArea<IMPLTYPE>, IHCButton<IMPLTYPE>, IHCCanvas<IMPLTYPE>, IHCCell<IMPLTYPE>, IHCCol<IMPLTYPE>, IHCControl<IMPLTYPE>, IHCDefinitionItem<IMPLTYPE>, IHCDiv<IMPLTYPE>, IHCElement<IMPLTYPE>, IHCElementWithChildren<IMPLTYPE>, IHCElementWithInternalChildren<IMPLTYPE,CHILDTYPE>, IHCFooter<IMPLTYPE>, IHCForm<IMPLTYPE>, IHCIFrame<IMPLTYPE>, IHCImg<IMPLTYPE>, IHCInput<IMPLTYPE>, IHCLabel<IMPLTYPE>, IHCLI<IMPLTYPE>, IHCList<IMPLTYPE,ITEMTYPE>, IHCMediaElement<IMPLTYPE>, IHCMediaElementChild<IMPLTYPE>, IHCMeter<IMPLTYPE>, IHCNav<IMPLTYPE>, IHCObject<IMPLTYPE>, IHCOL<IMPLTYPE>, IHCOLBase<IMPLTYPE,ITEMTYPE>, IHCPre<IMPLTYPE>, IHCProgress<IMPLTYPE>, IHCRubyChild<IMPLTYPE>, IHCScript<IMPLTYPE>, IHCScriptInline<IMPLTYPE>, IHCSelect<IMPLTYPE>, IHCSpan<IMPLTYPE>, IHCTable<IMPLTYPE>, IHCTablePart<IMPLTYPE>, IHCTextArea<IMPLTYPE>, IHCUL<IMPLTYPE>, IHCULBase<IMPLTYPE,ITEMTYPE>

All Known Implementing Classes:

AbstractHCA, AbstractHCArea, AbstractHCBaseTable, AbstractHCBlockQuote, AbstractHCButton, AbstractHCCanvas, AbstractHCCell, AbstractHCCheckBox, AbstractHCCol, AbstractHCControl, AbstractHCDefinitionItem, AbstractHCDiv, AbstractHCElement, AbstractHCElementWithChildren, AbstractHCElementWithInternalChildren, AbstractHCFooter, AbstractHCForm, AbstractHCH1, AbstractHCH2, AbstractHCH3, AbstractHCH4, AbstractHCH5, AbstractHCH6, AbstractHCIFrame, AbstractHCImg, AbstractHCInput, AbstractHCLabel, AbstractHCLI, AbstractHCList, AbstractHCListLI, AbstractHCMediaElement, AbstractHCMediaElementChild, AbstractHCMeter, AbstractHCNav, AbstractHCObject, AbstractHCOL, AbstractHCOLBase, AbstractHCPre, AbstractHCProgress, AbstractHCRadioButton, AbstractHCRubyChild, AbstractHCScript, AbstractHCScriptInline, AbstractHCSelect, AbstractHCSpan, AbstractHCTable, AbstractHCTablePart, AbstractHCTextArea, AbstractHCUL, AbstractHCULBase, HCA, HCA_JS, HCA_MailTo, HCAbbr, HCAddress, HCArea, HCArticle, HCAside, HCAudio, HCB, HCBase, HCBDI, HCBDO, HCBlockQuote, HCBody, HCBR, HCButton, HCButton_Reset, HCButton_Submit, HCCanvas, HCCaption, HCCenter, HCCheckBox, HCCite, HCCode, HCCol, HCColGroup, HCCommand, HCData, HCDataList, HCDD, HCDel, HCDetails, HCDFN, HCDialog, HCDir, HCDiv, HCDL, HCDT, HCEdit, HCEditFile, HCEditPassword, HCEM, HCEmbed, HCFieldSet, HCFigCaption, HCFigure, HCFont, HCFooter, HCForm, HCFrame, HCFrameset, HCGenericElement, HCGenericElementWithChildren, HCH1, HCH2, HCH3, HCH4, HCH5, HCH6, HCHead, HCHeader, HCHGroup, HCHiddenField, HCHR, HCHtml, HCI, HCIFrame, HCImg, HCInput, HCIns, HCKBD, HCLabel, HCLegend, HCLI, HCLink, HCLinkButton, HCMain, HCMap, HCMark, HCMenu, HCMenuItem, HCMeta, HCMeter, HCNav, HCNoBR, HCNoScript, HCObject, HCOL, HCOptGroup, HCOption, HCOutput, HCP, HCParam, HCPicture, HCPre, HCProgress, HCQ, HCRadioButton, HCRow, HCRP, HCRT, HCRuby, HCS, HCSamp, HCScriptFile, HCScriptInline, HCScriptInlineOnDocumentReady, HCSection, HCSelect, HCSlot, HCSmall, HCSource, HCSpan, HCStrong, HCStyle, HCSub, HCSummary, HCSup, HCTable, HCTBody, HCTD, HCTextArea, HCTFoot, HCTH, HCTHead, HCTime, HCTitle, HCTrack, HCU, HCUL, HCVar, HCVideo, HCWBR

public interface IHCHasID<IMPLTYPE extends IHCHasID<IMPLTYPE>>
extends com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>

Special interface for HC elements having an optional ID

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
default IMPLTYPE	ensureID()	Set a new ID if none is present.
String	getID()	Get the HTML ID of this object. Note: we cannot use IHasID<String> because the constraint of IHasID is, that the returned ID may not be null whereas here the HTML ID can be null!
default boolean	hasID()
default boolean	hasNoID()
IMPLTYPE	setID(String sID)	Set the HTML ID of this object.
default IMPLTYPE	setUniqueID()	Set a unique HTML ID for this object.

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

thisAsT

Method Detail

getID

@Nullable
String getID()

Get the HTML ID of this object.
Note: we cannot use IHasID<String> because the constraint of IHasID is, that the returned ID may not be null whereas here the HTML ID can be null!

Returns:

The HTML ID of this object.

hasID

default boolean hasID()

Returns:

true if this element has an ID, false if not.

hasNoID

default boolean hasNoID()

Returns:

true if this element has no ID, false if it has one.

setID

@Nonnull
IMPLTYPE setID(@Nullable
               String sID)

Set the HTML ID of this object.

Parameters:

sID - The ID to use. Must conform to the HTML rules for an element ID.

Returns:

this

setUniqueID

@Nonnull
default IMPLTYPE setUniqueID()

Set a unique HTML ID for this object. Equal to setID (GlobalIDFactory.getNewStringID ())

Returns:

this

ensureID

@Nonnull
default IMPLTYPE ensureID()

Set a new ID if none is present. This is a shortcut for if (!hasID())setUniqueID ();

Returns:

this