java.lang.Object
- com.helger.html.hc.impl.AbstractHCNode
- - com.helger.html.hc.html.AbstractHCElement<IMPLTYPE>

Type Parameters:

IMPLTYPE - The 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>, IHCHasID<IMPLTYPE>, IHCNode, Serializable

Direct Known Subclasses:

AbstractHCArea, AbstractHCBaseTable, AbstractHCCol, AbstractHCControl, AbstractHCElementWithInternalChildren, AbstractHCMediaElementChild, AbstractHCScript, HCBase, HCBR, HCCommand, HCEmbed, HCFrame, HCGenericElement, HCHead, HCHR, HCHtml, HCLink, HCMeta, HCParam, HCStyle, HCTitle, HCWBR
```
@NotThreadSafe
public abstract class AbstractHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
extends AbstractHCNode
implements IHCElement<IMPLTYPE>
```
Base class for an HC element.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static boolean`	`DEFAULT_HIDDEN`	By default an element is not hidden
`static boolean`	`DEFAULT_SPELLCHECK`	By default an element is not spell checked
`static com.helger.commons.state.ETriState`	`DEFAULT_TRANSLATE`	Default translate mode
`static boolean`	`DEFAULT_UNFOCUSABLE`	By default an element is not unfocusable

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

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractHCElement(EHTMLElement eElement)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`IMPLTYPE`	`addClass(ICSSClassProvider aCSSClassProvider)`
`IMPLTYPE`	`addEventHandler(EJSEvent eJSEvent, IHasJSCode aJSCode)`	Add a JS event handler at the end.
`IMPLTYPE`	`addStyle(com.helger.css.propertyvalue.ICSSValue aValue)`	Add an element specific style.
`boolean`	`containsClass(ICSSClassProvider aCSSClassProvider)`	Check if the passed CSS class is present or not.
`boolean`	`containsEventHandler(EJSEvent eJSEvent)`	Check if any event handler is registered for the specified event.
`boolean`	`containsStyle(com.helger.css.property.ECSSProperty eProperty)`	Check if a style value is associated to a single property.
`protected com.helger.xml.microdom.IMicroElement`	`createMicroElement(IHCConversionSettingsToNode aConversionSettings)`
`IHCAttrContainer`	`customAttrs()`
`protected void`	`fillMicroElement(com.helger.xml.microdom.IMicroElement aElement, IHCConversionSettingsToNode aConversionSettings)`	Set all attributes and child elements of this object
`protected void`	`finishMicroElement(com.helger.xml.microdom.IMicroElement eElement, IHCConversionSettingsToNode aConversionSettings)`	This method is called after the element itself was created and filled.
`String`	`getAccessKey()`
`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()`
`com.helger.commons.collection.impl.ICommonsOrderedMap<com.helger.css.property.ECSSProperty,com.helger.css.propertyvalue.ICSSValue>`	`getAllStyles()`
`String`	`getAllStylesAsString(com.helger.css.ICSSWriterSettings aCSSSettings)`	The value to be set to the HTML style attribute
`com.helger.commons.collection.impl.ICommonsList<com.helger.css.propertyvalue.ICSSValue>`	`getAllStyleValues()`
`EHCContentEditable`	`getContentEditable()`
`EHCTextDirection`	`getDirection()`
`EHCDraggable`	`getDraggable()`
`EHTMLElement`	`getElement()`
`IHasJSCode`	`getEventHandler(EJSEvent eJSEvent)`	Get the event handler of the specified event.
`JSEventMap`	`getEventMap()`
`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`!
`String`	`getLanguage()`
`EHTMLRole`	`getRole()`
`com.helger.css.propertyvalue.ICSSValue`	`getStyleValue(com.helger.css.property.ECSSProperty eProperty)`	Find the style value associated to a single property.
`long`	`getTabIndex()`
`String`	`getTagName()`
`String`	`getTitle()`
`com.helger.commons.state.ETriState`	`getTranslate()`
`boolean`	`hasAnyClass()`
`boolean`	`hasAnyStyle()`
`boolean`	`hasStyle(com.helger.css.propertyvalue.ICSSValue aValue)`	Check if the style property is contained, and the value matches.
`protected com.helger.xml.microdom.IMicroNode`	`internalConvertToMicroNode(IHCConversionSettingsToNode aConversionSettings)`
`boolean`	`isHidden()`
`boolean`	`isSpellCheck()`
`boolean`	`isTranslateOff()`
`boolean`	`isTranslateOn()`
`boolean`	`isTranslateUndefined()`
`boolean`	`isUnfocusable()`
`static boolean`	`isValidID(String sID)`
`protected void`	`onConsistencyCheck(IHCConversionSettingsToNode aConversionSettings)`
`protected void`	`onFinalizeNodeState(IHCConversionSettingsToNode aConversionSettings, IHCHasChildrenMutable<?,? super IHCNode> aTargetNode)`	Finalize the node by applying any internal state that was not yet converted to a HC element.
`IMPLTYPE`	`prependEventHandler(EJSEvent eJSEvent, IHasJSCode aJSCode)`	Add a JS event handler at the front.
`IMPLTYPE`	`removeAllClasses()`	Remove all previously added CSS classes at once.
`IMPLTYPE`	`removeAllEventHandler(EJSEvent eJSEvent)`	Remove all event handler for the specified JS event.
`IMPLTYPE`	`removeAllStyles()`	Remove all styles from the element
`IMPLTYPE`	`removeClass(ICSSClassProvider aCSSClassProvider)`	Remove the specified CSS class if present.
`IMPLTYPE`	`removeStyle(com.helger.css.property.ECSSProperty eProperty)`	Remove the specified style from the element
`IMPLTYPE`	`setAccessKey(String sAccessKey)`	Set the value of the HTML `accesskey` attribute.
`IMPLTYPE`	`setContentEditable(EHCContentEditable eContentEditable)`	Change the content editable state
`IMPLTYPE`	`setDirection(EHCTextDirection eDirection)`	Set the value of the HTML `dir` attribute.
`IMPLTYPE`	`setDraggable(EHCDraggable eDraggable)`	Set the draggable state of this element
`IMPLTYPE`	`setEventHandler(EJSEvent eJSEvent, IHasJSCode aJSCode)`	Set a JS event handler.
`IMPLTYPE`	`setHidden(boolean bHidden)`	Set the hidden state of this element
`IMPLTYPE`	`setID(String sID)`	Set the HTML ID of this object.
`IMPLTYPE`	`setID(String sID, boolean bImSureToOverwriteAnExistingID)`
`IMPLTYPE`	`setLanguage(String sLanguage)`	Set the value of the HTML `lang` attribute.
`IMPLTYPE`	`setRole(EHTMLRole eRole)`	Set the role attribute of this element.
`IMPLTYPE`	`setSpellCheck(boolean bSpellCheck)`	Set the value of the HTML `spellcheck` attribute.
`IMPLTYPE`	`setTabIndex(long nTabIndex)`	Set the tab index of this object.
`IMPLTYPE`	`setTitle(String sTitle)`	Set the value of the HTML `title` attribute.
`IMPLTYPE`	`setTranslate(com.helger.commons.state.ETriState eTranslate)`	Set the value of the HTML `translate` attribute.
`IMPLTYPE`	`setUnfocusable(boolean bUnfocusable)`	Set the unfocusable state of this element.
`String`	`toString()`

Methods inherited from class com.helger.html.hc.impl.AbstractHCNode
canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getChildAtIndex, getChildCount, getChildren, getFirstChild, getLastChild, getNodeState, getPlainText, hasChildren, 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
setTranslate, withCustomAttrs

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSClasses
addClasses, addClasses, addClasses

Methods inherited from interface com.helger.html.hc.html.IHCHasCSSStyles
addStyle, addStyles, addStyles, addStyles

Methods inherited from interface com.helger.html.hc.IHCHasID
ensureID, hasID, hasNoID, setUniqueID

Methods inherited from interface com.helger.html.hc.IHCNode
canConvertToMicroNode, consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, getPlainText, registerExternalResources

- Field Detail
  - DEFAULT_TRANSLATE
```
public static final com.helger.commons.state.ETriState DEFAULT_TRANSLATE
```
    Default translate mode
  - DEFAULT_UNFOCUSABLE
```
public static final boolean DEFAULT_UNFOCUSABLE
```
    By default an element is not unfocusable
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HIDDEN
```
public static final boolean DEFAULT_HIDDEN
```
    By default an element is not hidden
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SPELLCHECK
```
public static final boolean DEFAULT_SPELLCHECK
```
    By default an element is not spell checked
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - AbstractHCElement
```
protected AbstractHCElement(@Nonnull
                            EHTMLElement eElement)
```
- Method Detail
  - getElement
```
@Nonnull
public final EHTMLElement getElement()
```
    Specified by:
    
    getElement in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The contained HTML element. Never null.
  - getTagName
```
@Nonnull
@Nonempty
public final String getTagName()
```
    Specified by:
    
    getTagName in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The tag name of this element (without namespace)
  - getID
```
@Nullable
public final String getID()
```
    Description copied from interface: IHCHasID
    
    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!
    
    Specified by:
    
    getID in interface IHCHasID<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The HTML ID of this object.
  - setID
```
@Nonnull
public final IMPLTYPE setID(@Nullable
                            String sID)
```
    Description copied from interface: IHCHasID
    
    Set the HTML ID of this object.
    
    Specified by:
    
    setID in interface IHCHasID<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    sID - The ID to use. Must conform to the HTML rules for an element ID.
    
    Returns:
    
    this
  - isValidID
```
public static boolean isValidID(@Nullable
                                String sID)
```
  - setID
```
@Nonnull
public final IMPLTYPE setID(@Nullable
                            String sID,
                            boolean bImSureToOverwriteAnExistingID)
```
  - getTitle
```
@Nullable
public final String getTitle()
```
    Specified by:
    
    getTitle in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The value of the HTML title attribute. May be null.
  - setTitle
```
@Nonnull
public final IMPLTYPE setTitle(@Nullable
                               String sTitle)
```
    Description copied from interface: IHCElement
    
    Set the value of the HTML title attribute.
    
    Specified by:
    
    setTitle in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    sTitle - The new title. May be null.
    
    Returns:
    
    this
  - containsClass
```
public final 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<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    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 final IMPLTYPE addClass(@Nullable
                               ICSSClassProvider aCSSClassProvider)
```
    Specified by:
    
    addClass in interface IHCHasCSSClasses<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
  - removeClass
```
@Nonnull
public final IMPLTYPE removeClass(@Nullable
                                  ICSSClassProvider aCSSClassProvider)
```
    Description copied from interface: IHCHasCSSClasses
    
    Remove the specified CSS class if present.
    
    Specified by:
    
    removeClass in interface IHCHasCSSClasses<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    aCSSClassProvider - The CSS class provider to use. May be null.
    
    Returns:
    
    this
  - removeAllClasses
```
@Nonnull
public final IMPLTYPE removeAllClasses()
```
    Description copied from interface: IHCHasCSSClasses
    
    Remove all previously added CSS classes at once.
    
    Specified by:
    
    removeAllClasses in interface IHCHasCSSClasses<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    this
  - getAllClasses
```
@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsOrderedSet<ICSSClassProvider> getAllClasses()
```
    Specified by:
    
    getAllClasses in interface IHCHasCSSClasses<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    A sorted set with all registered CSS class providers. Never null.
  - getAllClassNames
```
@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsOrderedSet<String> getAllClassNames()
```
    Specified by:
    
    getAllClassNames in interface IHCHasCSSClasses<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    A set with all CSS class names registered so far. Never null.
  - hasAnyClass
```
public final boolean hasAnyClass()
```
    Specified by:
    
    hasAnyClass in interface IHCHasCSSClasses<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    true if at least one CSS class is assigned, false otherwise.
  - getAllClassesAsString
```
@Nullable
public final 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<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    null if no classes are present.
  - getAllStyles
```
@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsOrderedMap<com.helger.css.property.ECSSProperty,com.helger.css.propertyvalue.ICSSValue> getAllStyles()
```
    Specified by:
    
    getAllStyles in interface IHCHasCSSStyles<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    A copy of all contained styles. Never null.
  - getAllStyleValues
```
@Nonnull
@ReturnsMutableCopy
public final com.helger.commons.collection.impl.ICommonsList<com.helger.css.propertyvalue.ICSSValue> getAllStyleValues()
```
    Specified by:
    
    getAllStyleValues in interface IHCHasCSSStyles<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    All style values. Never null.
  - getStyleValue
```
@Nullable
public final com.helger.css.propertyvalue.ICSSValue getStyleValue(@Nullable
                                                                  com.helger.css.property.ECSSProperty eProperty)
```
    Description copied from interface: IHCHasCSSStyles
    
    Find the style value associated to a single property.
    
    Specified by:
    
    getStyleValue in interface IHCHasCSSStyles<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eProperty - The property to search. May be null.
    
    Returns:
    
    null if no such style is contained.
  - containsStyle
```
public final boolean containsStyle(@Nullable
                                   com.helger.css.property.ECSSProperty eProperty)
```
    Description copied from interface: IHCHasCSSStyles
    
    Check if a style value is associated to a single property.
    
    Specified by:
    
    containsStyle in interface IHCHasCSSStyles<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eProperty - The property to search. May be null.
    
    Returns:
    
    true if a respective style is present, false otherwise.
  - hasStyle
```
public final boolean hasStyle(@Nullable
                              com.helger.css.propertyvalue.ICSSValue aValue)
```
    Description copied from interface: IHCHasCSSStyles
    
    Check if the style property is contained, and the value matches.
    
    Specified by:
    
    hasStyle in interface IHCHasCSSStyles<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    aValue - The value to be checked
    
    Returns:
    
    true if such a CSS value is contained, false otherwise
  - hasAnyStyle
```
public final boolean hasAnyStyle()
```
    Specified by:
    
    hasAnyStyle in interface IHCHasCSSStyles<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    true if at least one CSS style is assigned, false otherwise.
  - addStyle
```
@Nonnull
public final IMPLTYPE addStyle(@Nullable
                               com.helger.css.propertyvalue.ICSSValue aValue)
```
    Description copied from interface: IHCHasCSSStyles
    
    Add an element specific style.
    
    Specified by:
    
    addStyle in interface IHCHasCSSStyles<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    aValue - The value to be added. May be null.
    
    Returns:
    
    this
  - removeStyle
```
@Nonnull
public final IMPLTYPE removeStyle(@Nonnull
                                  com.helger.css.property.ECSSProperty eProperty)
```
    Description copied from interface: IHCHasCSSStyles
    
    Remove the specified style from the element
    
    Specified by:
    
    removeStyle in interface IHCHasCSSStyles<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eProperty - The style property to remove
    
    Returns:
    
    this
  - removeAllStyles
```
@Nonnull
public final IMPLTYPE removeAllStyles()
```
    Description copied from interface: IHCHasCSSStyles
    
    Remove all styles from the element
    
    Specified by:
    
    removeAllStyles in interface IHCHasCSSStyles<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    this
  - getAllStylesAsString
```
@Nullable
public final String getAllStylesAsString(@Nonnull
                                         com.helger.css.ICSSWriterSettings aCSSSettings)
```
    Description copied from interface: IHCHasCSSStyles
    
    The value to be set to the HTML style attribute
    
    Specified by:
    
    getAllStylesAsString in interface IHCHasCSSStyles<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    aCSSSettings - The CSS settings to use
    
    Returns:
    
    null if no styles are present
  - getDirection
```
@Nullable
public final EHCTextDirection getDirection()
```
    Specified by:
    
    getDirection in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The value of the HTML dir attribute. May be null.
  - setDirection
```
@Nonnull
public final IMPLTYPE setDirection(@Nullable
                                   EHCTextDirection eDirection)
```
    Description copied from interface: IHCElement
    
    Set the value of the HTML dir attribute.
    
    Specified by:
    
    setDirection in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eDirection - The new direction. May be null.
    
    Returns:
    
    this
  - getLanguage
```
@Nullable
public final String getLanguage()
```
    Specified by:
    
    getLanguage in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The value of the HTML lang attribute. May be null.
  - setLanguage
```
@Nonnull
public final IMPLTYPE setLanguage(@Nullable
                                  String sLanguage)
```
    Description copied from interface: IHCElement
    
    Set the value of the HTML lang attribute.
    
    Specified by:
    
    setLanguage in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    sLanguage - The new language. May be null.
    
    Returns:
    
    this
  - getEventMap
```
@Nullable
@ReturnsMutableObject
public final JSEventMap getEventMap()
```
    Specified by:
    
    getEventMap in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
  - getEventHandler
```
@Nullable
public final IHasJSCode getEventHandler(@Nullable
                                        EJSEvent eJSEvent)
```
    Description copied from interface: IHCElement
    
    Get the event handler of the specified event.
    
    Specified by:
    
    getEventHandler in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eJSEvent - The event to query. May be null.
    
    Returns:
    
    null if no such event handler is registered.
  - containsEventHandler
```
public final boolean containsEventHandler(@Nullable
                                          EJSEvent eJSEvent)
```
    Description copied from interface: IHCElement
    
    Check if any event handler is registered for the specified event.
    
    Specified by:
    
    containsEventHandler in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eJSEvent - The event to be queried. May be null.
    
    Returns:
    
    true of a non-null event is specified, and if a handler is present.
  - addEventHandler
```
@Nonnull
public final IMPLTYPE addEventHandler(@Nonnull
                                      EJSEvent eJSEvent,
                                      @Nullable
                                      IHasJSCode aJSCode)
```
    Description copied from interface: IHCElement
    
    Add a JS event handler at the end.
    
    Specified by:
    
    addEventHandler in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eJSEvent - The event to use. May not be null.
    
    aJSCode - The JSCode to be executed on the specified event. May be null in which case nothing happens.
    
    Returns:
    
    this.
  - prependEventHandler
```
@Nonnull
public final IMPLTYPE prependEventHandler(@Nonnull
                                          EJSEvent eJSEvent,
                                          @Nullable
                                          IHasJSCode aJSCode)
```
    Description copied from interface: IHCElement
    
    Add a JS event handler at the front.
    
    Specified by:
    
    prependEventHandler in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eJSEvent - The event to use. May not be null.
    
    aJSCode - The JSCode to be executed on the specified event. May be null in which case nothing happens.
    
    Returns:
    
    this.
  - setEventHandler
```
@Nonnull
public final IMPLTYPE setEventHandler(@Nonnull
                                      EJSEvent eJSEvent,
                                      @Nullable
                                      IHasJSCode aJSCode)
```
    Description copied from interface: IHCElement
    
    Set a JS event handler. All eventually present event handlers are overwritten.
    
    Specified by:
    
    setEventHandler in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eJSEvent - The event to set. May not be null.
    
    aJSCode - The JSCode to be executed on the specified event. May be null in which case no event handler will be present after the call.
    
    Returns:
    
    this.
  - removeAllEventHandler
```
@Nonnull
public final IMPLTYPE removeAllEventHandler(@Nullable
                                            EJSEvent eJSEvent)
```
    Description copied from interface: IHCElement
    
    Remove all event handler for the specified JS event.
    
    Specified by:
    
    removeAllEventHandler in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eJSEvent - The JS event to remove the handler. May be null.
    
    Returns:
    
    this
  - isUnfocusable
```
public final boolean isUnfocusable()
```
    Specified by:
    
    isUnfocusable in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    true if this element cannot be focused.
  - setUnfocusable
```
@Nonnull
public final IMPLTYPE setUnfocusable(boolean bUnfocusable)
```
    Description copied from interface: IHCElement
    
    Set the unfocusable state of this element.
    
    Specified by:
    
    setUnfocusable in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    bUnfocusable - true to make it unfocusable, false otherwise.
    
    Returns:
    
    this
  - isHidden
```
public final boolean isHidden()
```
    Specified by:
    
    isHidden in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    true if this is hidden
  - setHidden
```
@Nonnull
public final IMPLTYPE setHidden(boolean bHidden)
```
    Description copied from interface: IHCElement
    
    Set the hidden state of this element
    
    Specified by:
    
    setHidden in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    bHidden - true if it is hidden, false otherwise
    
    Returns:
    
    this
  - getTabIndex
```
@CheckForSigned
public final long getTabIndex()
```
    Specified by:
    
    getTabIndex in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The tab index of this object. The semantics of negative values depends on the browser! In HTML5 negative values are allowed but won't set a focus when tabbing. The default value is indicated by IHCElement.DEFAULT_TABINDEX
  - setTabIndex
```
@Nonnull
public final IMPLTYPE setTabIndex(long nTabIndex)
```
    Description copied from interface: IHCElement
    
    Set the tab index of this object. This is a common element in HTML5 only. The default value is IHCElement.DEFAULT_TABINDEX
    
    Specified by:
    
    setTabIndex in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    nTabIndex - The tab-index of this object. The semantics of negative values depends on the browser! In HTML5 negative values are allowed but won't set a focus when tabbing.
    
    Returns:
    
    this
  - getAccessKey
```
@Nullable
public final String getAccessKey()
```
    Specified by:
    
    getAccessKey in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The value of the HTML accesskey attribute. May be null.
  - setAccessKey
```
@Nonnull
public final IMPLTYPE setAccessKey(@Nullable
                                   String sAccessKey)
```
    Description copied from interface: IHCElement
    
    Set the value of the HTML accesskey attribute.
    
    Specified by:
    
    setAccessKey in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    sAccessKey - The new accesskey. May be null.
    
    Returns:
    
    this
  - isTranslateOn
```
public final boolean isTranslateOn()
```
    Specified by:
    
    isTranslateOn in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    true if HTML translate is true.
  - isTranslateOff
```
public final boolean isTranslateOff()
```
    Specified by:
    
    isTranslateOff in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    true if HTML translate is false.
  - isTranslateUndefined
```
public final boolean isTranslateUndefined()
```
    Specified by:
    
    isTranslateUndefined in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    true if HTML translate is not set.
  - getTranslate
```
@Nonnull
public final com.helger.commons.state.ETriState getTranslate()
```
    Specified by:
    
    getTranslate in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The value of the HTML translate attribute. Never null.
  - setTranslate
```
@Nonnull
public final IMPLTYPE setTranslate(@Nonnull
                                   com.helger.commons.state.ETriState eTranslate)
```
    Description copied from interface: IHCElement
    
    Set the value of the HTML translate attribute.
    
    Specified by:
    
    setTranslate in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eTranslate - The new translate state. May not be null.
    
    Returns:
    
    this
  - getContentEditable
```
@Nullable
public final EHCContentEditable getContentEditable()
```
    Specified by:
    
    getContentEditable in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The current state of content editable
  - setContentEditable
```
@Nonnull
public final IMPLTYPE setContentEditable(@Nullable
                                         EHCContentEditable eContentEditable)
```
    Description copied from interface: IHCElement
    
    Change the content editable state
    
    Specified by:
    
    setContentEditable in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eContentEditable - New value. May be null.
    
    Returns:
    
    this
  - getDraggable
```
@Nullable
public final EHCDraggable getDraggable()
```
    Specified by:
    
    getDraggable in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    the draggable state. May be null.
  - setDraggable
```
@Nonnull
public final IMPLTYPE setDraggable(@Nullable
                                   EHCDraggable eDraggable)
```
    Description copied from interface: IHCElement
    
    Set the draggable state of this element
    
    Specified by:
    
    setDraggable in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eDraggable - Value to set. May be null.
    
    Returns:
    
    this
  - isSpellCheck
```
public final boolean isSpellCheck()
```
    Specified by:
    
    isSpellCheck in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    true if spell check is enabled, false otherwise.
  - setSpellCheck
```
@Nonnull
public final IMPLTYPE setSpellCheck(boolean bSpellCheck)
```
    Description copied from interface: IHCElement
    
    Set the value of the HTML spellcheck attribute.
    
    Specified by:
    
    setSpellCheck in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    bSpellCheck - true to enabled, false otherwise.
    
    Returns:
    
    this
  - getRole
```
@Nullable
public final EHTMLRole getRole()
```
    Specified by:
    
    getRole in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    The role of this element. May be null. By default an element has no role.
  - setRole
```
@Nonnull
public final IMPLTYPE setRole(@Nullable
                              EHTMLRole eRole)
```
    Description copied from interface: IHCElement
    
    Set the role attribute of this element.
    
    Specified by:
    
    setRole in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Parameters:
    
    eRole - The role to set. May be null. According to the specs, abstract roles should not be used!
    
    Returns:
    
    this
  - customAttrs
```
@Nonnull
@ReturnsMutableCopy
public final IHCAttrContainer customAttrs()
```
    Specified by:
    
    customAttrs in interface IHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>
    
    Returns:
    
    A non-null set of "custom" attributes for which no predefined method binding is available. Used e.g. for "aria-*" and "data-*" attributes.
  - onFinalizeNodeState
```
@OverridingMethodsMustInvokeSuper
protected void onFinalizeNodeState(@Nonnull
                                   IHCConversionSettingsToNode aConversionSettings,
                                   @Nonnull
                                   IHCHasChildrenMutable<?,? super IHCNode> aTargetNode)
```
    Description copied from class: AbstractHCNode
    
    Finalize the node by applying any internal state that was not yet converted to a HC element. This method is called at maximum once per IHCNode. It is safe to still add classes, style or children to this node in this method.
    
    Overrides:
    
    onFinalizeNodeState in class AbstractHCNode
    
    Parameters:
    
    aConversionSettings - HC conversion settings
    
    aTargetNode - The target node where additional nodes should be added
  - onConsistencyCheck
```
protected void onConsistencyCheck(@Nonnull
                                  IHCConversionSettingsToNode aConversionSettings)
```
    Overrides:
    
    onConsistencyCheck in class AbstractHCNode
    
    Parameters:
    
    aConversionSettings - HC conversion settings
  - createMicroElement
```
@OverrideOnDemand
@Nonnull
protected com.helger.xml.microdom.IMicroElement createMicroElement(@Nonnull
                                                                   IHCConversionSettingsToNode aConversionSettings)
```
    Parameters:
    
    aConversionSettings - The conversion settings to be used
    
    Returns:
    
    The created micro element for this HC element. May not be null.
  - fillMicroElement
```
@OverrideOnDemand
@OverridingMethodsMustInvokeSuper
protected void fillMicroElement(@Nonnull
                                com.helger.xml.microdom.IMicroElement aElement,
                                @Nonnull
                                IHCConversionSettingsToNode aConversionSettings)
```
    Set all attributes and child elements of this object
    
    Parameters:
    
    aElement - The current micro element to be filled. Never null.
    
    aConversionSettings - The conversion settings to be used. Never null.
  - finishMicroElement
```
@OverrideOnDemand
protected void finishMicroElement(@Nonnull
                                  com.helger.xml.microdom.IMicroElement eElement,
                                  @Nonnull
                                  IHCConversionSettingsToNode aConversionSettings)
```
    This method is called after the element itself was created and filled. Overwrite this method to perform actions that can only be done after the element was build finally.
    
    Parameters:
    
    eElement - The created micro element
    
    aConversionSettings - The conversion settings to be used
  - internalConvertToMicroNode
```
@Nonnull
@OverridingMethodsMustInvokeSuper
protected com.helger.xml.microdom.IMicroNode internalConvertToMicroNode(@Nonnull
                                                                        IHCConversionSettingsToNode aConversionSettings)
```
    Specified by:
    
    internalConvertToMicroNode in class AbstractHCNode
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class AbstractHCNode

Class AbstractHCElement<IMPLTYPE extends AbstractHCElement<IMPLTYPE>>

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

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

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

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

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

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

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

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

Field Detail

DEFAULT_TRANSLATE

DEFAULT_UNFOCUSABLE

DEFAULT_HIDDEN

DEFAULT_SPELLCHECK

Constructor Detail

AbstractHCElement

Method Detail

getElement

getTagName

getID

setID

isValidID

setID

getTitle

setTitle

containsClass

addClass

removeClass

removeAllClasses

getAllClasses

getAllClassNames

hasAnyClass

getAllClassesAsString

getAllStyles

getAllStyleValues

getStyleValue

containsStyle

hasStyle

hasAnyStyle

addStyle

removeStyle

removeAllStyles

getAllStylesAsString

getDirection

setDirection

getLanguage

setLanguage

getEventMap

getEventHandler

containsEventHandler

addEventHandler

prependEventHandler

setEventHandler

removeAllEventHandler

isUnfocusable

setUnfocusable

isHidden

setHidden

getTabIndex

setTabIndex

getAccessKey

setAccessKey

isTranslateOn

isTranslateOff

isTranslateUndefined

getTranslate

setTranslate

getContentEditable

setContentEditable

getDraggable

setDraggable

isSpellCheck

setSpellCheck