Package com.helger.html.hc.html.forms

Class AbstractHCControl<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

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

com.helger.html.hc.html.forms.AbstractHCControl<IMPLTYPE>

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>, IHCControl<IMPLTYPE>, IHCHasFocus<IMPLTYPE>, IHCElement<IMPLTYPE>, IHCHasCSSClasses<IMPLTYPE>, IHCHasCSSStyles<IMPLTYPE>, IHCHasState<IMPLTYPE>, IHCHasID<IMPLTYPE>, IHCHasName<IMPLTYPE>, IHCNode, Serializable

Direct Known Subclasses:

AbstractHCInput, AbstractHCSelect, AbstractHCTextArea

@NotThreadSafe
public abstract class AbstractHCControl<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>
extends AbstractHCElement<IMPLTYPE>
implements IHCControl<IMPLTYPE>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static ICSSClassProvider	CSS_CLASS_READ_ONLY
static boolean	DEFAULT_AUTO_FOCUS	By default auto focus is disabled
static boolean	DEFAULT_DISABLED
static boolean	DEFAULT_READ_ONLY
static boolean	DEFAULT_REQUIRED	By default required is disabled

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

Constructor	Description
AbstractHCControl(EHTMLElement aElement)

Method Summary

Modifier and Type	Method	Description
protected void	fillMicroElement(com.helger.xml.microdom.IMicroElement aElement, IHCConversionSettingsToNode aConversionSettings)	Set all attributes and child elements of this object
String	getName()
boolean	isAutoFocus()
boolean	isDisabled()
boolean	isReadOnly()
boolean	isRequired()
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	setAutoFocus(boolean bAutoFocus)	Change the auto focused state of this element.
IMPLTYPE	setDisabled(boolean bDisabled)	Set the disabled state of this element.
IMPLTYPE	setName(String sName)	Set the name of the element.
IMPLTYPE	setReadOnly(boolean bReadOnly)
IMPLTYPE	setRequired(boolean bRequired)
String	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, 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

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

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

Field Detail

DEFAULT_DISABLED

public static final boolean DEFAULT_DISABLED

See Also:

Constant Field Values

DEFAULT_READ_ONLY

public static final boolean DEFAULT_READ_ONLY

See Also:

Constant Field Values

DEFAULT_REQUIRED

public static final boolean DEFAULT_REQUIRED

By default required is disabled

See Also:

Constant Field Values

DEFAULT_AUTO_FOCUS

public static final boolean DEFAULT_AUTO_FOCUS

By default auto focus is disabled

See Also:

Constant Field Values

CSS_CLASS_READ_ONLY

public static final ICSSClassProvider CSS_CLASS_READ_ONLY

Constructor Detail

AbstractHCControl

public AbstractHCControl(@Nonnull @Nonempty
                         EHTMLElement aElement)

Method Detail

isDisabled

public final boolean isDisabled()

Specified by:

isDisabled in interface IHCHasState<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

Returns:

true if the element is disabled, false otherwise.

setDisabled

@Nonnull
public final IMPLTYPE setDisabled(boolean bDisabled)

Description copied from interface: IHCHasState

Set the disabled state of this element.

Specified by:

setDisabled in interface IHCHasState<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

Parameters:

bDisabled - true to disable, false to enable

Returns:

this

getName

public final String getName()

Specified by:

getName in interface IHCHasName<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

Returns:

The name of the element. May be null.

setName

@Nonnull
public final IMPLTYPE setName(@Nullable
                              String sName)

Description copied from interface: IHCHasName

Set the name of the element.

Specified by:

setName in interface IHCHasName<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

Parameters:

sName - The new name. May be null.

Returns:

this

isReadOnly

public final boolean isReadOnly()

Specified by:

isReadOnly in interface IHCControl<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

setReadOnly

@Nonnull
public final IMPLTYPE setReadOnly(boolean bReadOnly)

Specified by:

setReadOnly in interface IHCControl<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

isRequired

public final boolean isRequired()

Specified by:

isRequired in interface IHCControl<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

setRequired

@Nonnull
public final IMPLTYPE setRequired(boolean bRequired)

Specified by:

setRequired in interface IHCControl<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

isAutoFocus

public final boolean isAutoFocus()

Specified by:

isAutoFocus in interface IHCHasFocus<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

Returns:

true if this element is focused, false otherwise. By default an element is not focused.

setAutoFocus

@Nonnull
public final IMPLTYPE setAutoFocus(boolean bAutoFocus)

Description copied from interface: IHCHasFocus

Change the auto focused state of this element.

Specified by:

setAutoFocus in interface IHCHasFocus<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

Parameters:

bAutoFocus - true to auto focus this element, false to not focus the element.

Returns:

this

onFinalizeNodeState

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 AbstractHCElement<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

Parameters:

aConversionSettings - HC conversion settings

aTargetNode - The target node where additional nodes should be added

fillMicroElement

@OverridingMethodsMustInvokeSuper
protected void fillMicroElement(com.helger.xml.microdom.IMicroElement aElement,
                                IHCConversionSettingsToNode aConversionSettings)

Description copied from class: AbstractHCElement

Set all attributes and child elements of this object

Overrides:

fillMicroElement in class AbstractHCElement<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>

Parameters:

aElement - The current micro element to be filled. Never null.

aConversionSettings - The conversion settings to be used. Never null.

toString

public String toString()

Overrides:

toString in class AbstractHCElement<IMPLTYPE extends AbstractHCControl<IMPLTYPE>>