Package com.helger.html.hc.html

Interface IHCHasCSSClasses<IMPLTYPE extends IHCHasCSSClasses<IMPLTYPE>>

Type Parameters:

IMPLTYPE - 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, HCHasCSSClasses, 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 IHCHasCSSClasses<IMPLTYPE extends IHCHasCSSClasses<IMPLTYPE>>
extends com.helger.commons.traits.IGenericImplTrait<IMPLTYPE>

Base interface for objects having CSS classes

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
IMPLTYPE	addClass(ICSSClassProvider aProvider)
default IMPLTYPE	addClasses(ICSSClassProvider aProvider)	Deprecated.
default IMPLTYPE	addClasses(ICSSClassProvider... aCSSClassProviders)	Add multiple unique CSS classes at once.
default IMPLTYPE	addClasses(Iterable<? extends ICSSClassProvider> aCSSClassProviders)	Add multiple unique CSS classes at once.
boolean	containsClass(ICSSClassProvider aProvider)	Check if the passed CSS class is present or not.
com.helger.commons.collection.impl.ICommonsOrderedSet<ICSSClassProvider>	getAllClasses()
String	getAllClassesAsString()	Get the string representation of all contained classes as it should be set to the HTML class attribute.
com.helger.commons.collection.impl.ICommonsOrderedSet<String>	getAllClassNames()
boolean	hasAnyClass()
IMPLTYPE	removeAllClasses()	Remove all previously added CSS classes at once.
IMPLTYPE	removeClass(ICSSClassProvider aProvider)	Remove the specified CSS class if present.

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

thisAsT

Method Detail

addClass

@Nonnull
IMPLTYPE addClass(@Nullable
                  ICSSClassProvider aProvider)

addClasses

@Deprecated(forRemoval=false)
@DevelopersNote("Use addClass instead!")
@Nonnull
default IMPLTYPE addClasses(@Nullable
                            ICSSClassProvider aProvider)

Deprecated.

addClasses

@Nonnull
default IMPLTYPE addClasses(@Nullable
                            ICSSClassProvider... aCSSClassProviders)

Add multiple unique CSS classes at once. Each CSS class that is already present, is ignored.

Parameters:

aCSSClassProviders - The CSS classed to add. May neither be null nor empty.

Returns:

this

addClasses

@Nonnull
default IMPLTYPE addClasses(@Nullable
                            Iterable<? extends ICSSClassProvider> aCSSClassProviders)

Add multiple unique CSS classes at once. Each CSS class that is already present, is ignored.

Parameters:

aCSSClassProviders - The CSS classed to add. May neither be null nor empty.

Returns:

this

removeClass

@Nonnull
IMPLTYPE removeClass(@Nullable
                     ICSSClassProvider aProvider)

Remove the specified CSS class if present.

Parameters:

aProvider - The CSS class provider to use. May be null.

Returns:

this

removeAllClasses

@Nonnull
IMPLTYPE removeAllClasses()

Remove all previously added CSS classes at once.

Returns:

this

containsClass

boolean containsClass(@Nullable
                      ICSSClassProvider aProvider)

Check if the passed CSS class is present or not.

Parameters:

aProvider - The CSS class provider to check. May be null.

Returns:

true if the passed CSS class is contained, false otherwise.

getAllClasses

@Nonnull
@ReturnsMutableCopy
com.helger.commons.collection.impl.ICommonsOrderedSet<ICSSClassProvider> getAllClasses()

Returns:

A sorted set with all registered CSS class providers. Never null.

getAllClassNames

@Nonnull
@ReturnsMutableCopy
com.helger.commons.collection.impl.ICommonsOrderedSet<String> getAllClassNames()

Returns:

A set with all CSS class names registered so far. Never null.

hasAnyClass

boolean hasAnyClass()

Returns:

true if at least one CSS class is assigned, false otherwise.

getAllClassesAsString

@Nullable
String getAllClassesAsString()

Get the string representation of all contained classes as it should be set to the HTML class attribute. A single blank is used as a separator.

Returns:

null if no classes are present.