Package com.helger.html.hc.ext

Class HCHasCSSClasses

java.lang.Object

com.helger.html.hc.ext.HCHasCSSClasses

All Implemented Interfaces:

com.helger.commons.traits.IGenericImplTrait<HCHasCSSClasses>, IHCHasCSSClasses<HCHasCSSClasses>

public class HCHasCSSClasses
extends Object
implements IHCHasCSSClasses<HCHasCSSClasses>

Stand alone implementation of IHCHasCSSClasses

Since:

4.5.2

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
HCHasCSSClasses()

Method Summary

Modifier and Type	Method	Description
HCHasCSSClasses	addClass(ICSSClassProvider aCSSClassProvider)
boolean	containsClass(ICSSClassProvider aCSSClassProvider)	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()
HCHasCSSClasses	removeAllClasses()	Remove all previously added CSS classes at once.
HCHasCSSClasses	removeClass(ICSSClassProvider aCSSClassProvider)	Remove the specified CSS class if present.
String	toString()

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.html.hc.html.IHCHasCSSClasses

addClasses, addClasses, addClasses

Constructor Detail

HCHasCSSClasses

public HCHasCSSClasses()

Method Detail

containsClass

public boolean containsClass(@Nullable
                             ICSSClassProvider aCSSClassProvider)

Description copied from interface: IHCHasCSSClasses

Check if the passed CSS class is present or not.

Specified by:

containsClass in interface IHCHasCSSClasses<HCHasCSSClasses>

Parameters:

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

Returns:

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

addClass

@Nonnull
public HCHasCSSClasses addClass(@Nullable
                                ICSSClassProvider aCSSClassProvider)

Specified by:

addClass in interface IHCHasCSSClasses<HCHasCSSClasses>

removeClass

@Nonnull
public HCHasCSSClasses removeClass(@Nullable
                                   ICSSClassProvider aCSSClassProvider)

Description copied from interface: IHCHasCSSClasses

Remove the specified CSS class if present.

Specified by:

removeClass in interface IHCHasCSSClasses<HCHasCSSClasses>

Parameters:

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

Returns:

this

removeAllClasses

@Nonnull
public HCHasCSSClasses removeAllClasses()

Description copied from interface: IHCHasCSSClasses

Remove all previously added CSS classes at once.

Specified by:

removeAllClasses in interface IHCHasCSSClasses<HCHasCSSClasses>

Returns:

this

getAllClasses

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

Specified by:

getAllClasses in interface IHCHasCSSClasses<HCHasCSSClasses>

Returns:

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

getAllClassNames

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

Specified by:

getAllClassNames in interface IHCHasCSSClasses<HCHasCSSClasses>

Returns:

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

getAllClassesAsString

@Nullable
public String getAllClassesAsString()

Description copied from interface: IHCHasCSSClasses

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.

Specified by:

getAllClassesAsString in interface IHCHasCSSClasses<HCHasCSSClasses>

Returns:

null if no classes are present.

hasAnyClass

public boolean hasAnyClass()

Specified by:

hasAnyClass in interface IHCHasCSSClasses<HCHasCSSClasses>

Returns:

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

toString

public String toString()

Overrides:

toString in class Object