Package com.helger.html.hc.html.embedded

Class AbstractHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

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

com.helger.html.hc.html.AbstractHCElementWithInternalChildren<IMPLTYPE,IHCNode>

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

com.helger.html.hc.html.embedded.AbstractHCIFrame<IMPLTYPE>

Type Parameters:

IMPLTYPE - 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>, IHCIFrame<IMPLTYPE>, IHCElement<IMPLTYPE>, IHCElementWithChildren<IMPLTYPE>, IHCElementWithInternalChildren<IMPLTYPE,IHCNode>, IHCHasCSSClasses<IMPLTYPE>, IHCHasCSSStyles<IMPLTYPE>, IHCHasChildrenMutable<IMPLTYPE,IHCNode>, IHCHasID<IMPLTYPE>, IHCNode, IHCNodeWithChildren<IMPLTYPE>, Serializable

Direct Known Subclasses:

HCIFrame

public abstract class AbstractHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>
extends AbstractHCElementWithChildren<IMPLTYPE>
implements IHCIFrame<IMPLTYPE>

Represents an HTML <iframe> element

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_FRAME_BORDER	By default a frame border is visible
static boolean	DEFAULT_SANDBOX	By default sandbox is disabled
static EHCScrolling	DEFAULT_SCROLLING	Default scrolling is auto

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
AbstractHCIFrame()

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
EHCIFrameAlign	getAlign()
String	getHeight()
EHCLoadingType	getLoading()
String	getLongDesc()
int	getMarginHeight()
int	getMarginWidth()
String	getName()
EnumSet<EHCSandboxAllow>	getSandboxAllow()
EHCScrolling	getScrolling()
com.helger.commons.url.ISimpleURL	getSrc()
String	getWidth()
boolean	isFrameBorder()
boolean	isSandbox()
IMPLTYPE	setAlign(EHCIFrameAlign eAlign)
IMPLTYPE	setFrameBorder(boolean bFrameBorder)
IMPLTYPE	setHeight(int nHeight)
IMPLTYPE	setHeightPercentage(double dPercentage)
IMPLTYPE	setLoading(EHCLoadingType eLoading)
IMPLTYPE	setLongDesc(String sLongDesc)
IMPLTYPE	setMarginHeight(int nMarginHeight)
IMPLTYPE	setMarginWidth(int nMarginWidth)
IMPLTYPE	setName(String sName)
IMPLTYPE	setSandbox(boolean bSandbox, EHCSandboxAllow... aSandboxAllows)
IMPLTYPE	setScrolling(EHCScrolling eScrolling)
IMPLTYPE	setSrc(com.helger.commons.url.ISimpleURL aSrc)
IMPLTYPE	setWidth(int nWidth)	Set the width in pixel
IMPLTYPE	setWidthPercentage(double dPercentage)
String	toString()

Methods inherited from class com.helger.html.hc.html.AbstractHCElementWithInternalChildren

addChild, addChildAt, afterAddChild, afterRemoveChild, beforeAddChild, canConvertToMicroNode, children, findFirstChild, findFirstChildMapped, forAllChildren, forAllChildren, forAllChildrenBreakable, forAllChildrenMapped, getAllChildren, getAllChildrenAsNodeList, getChildAtIndex, getChildCount, getChildren, getChildrenFormEmitting, getFirstChild, getLastChild, getPlainText, hasChildren, removeAllChildren, removeChild, removeChildAt, sortAllChildren

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, onFinalizeNodeState, 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

consistencyCheck, convertToMicroNode, customizeNode, finalizeNodeState, getNodeState, 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.IHCElementWithInternalChildren

recursiveContainsChildWithTagName

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

addAndReturnChild, addAndReturnChildAt, addChild, addChildAt, addChildren, addChildren, addChildren, addChildrenAt, addChildrenAt, getAllChildrenAsNodeList, removeAllChildren, removeChild, removeChildAt, setChild, sortAllChildren

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

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

addChild, addChildAt, addChildren, addChildren, setChild

Field Detail

DEFAULT_SCROLLING

public static final EHCScrolling DEFAULT_SCROLLING

Default scrolling is auto

DEFAULT_FRAME_BORDER

public static final boolean DEFAULT_FRAME_BORDER

By default a frame border is visible

See Also:

Constant Field Values

DEFAULT_SANDBOX

public static final boolean DEFAULT_SANDBOX

By default sandbox is disabled

See Also:

Constant Field Values

Constructor Detail

AbstractHCIFrame

public AbstractHCIFrame()

Method Detail

getSrc

@Nullable
public final com.helger.commons.url.ISimpleURL getSrc()

Specified by:

getSrc in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setSrc

@Nonnull
public final IMPLTYPE setSrc(@Nullable
                             com.helger.commons.url.ISimpleURL aSrc)

Specified by:

setSrc in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

getName

@Nullable
public final String getName()

Specified by:

getName in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setName

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

Specified by:

setName in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

getLongDesc

@Nullable
public final String getLongDesc()

Specified by:

getLongDesc in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setLongDesc

@Nonnull
public final IMPLTYPE setLongDesc(@Nullable
                                  String sLongDesc)

Specified by:

setLongDesc in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

getScrolling

@Nullable
public final EHCScrolling getScrolling()

Specified by:

getScrolling in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setScrolling

@Nonnull
public final IMPLTYPE setScrolling(@Nullable
                                   EHCScrolling eScrolling)

Specified by:

setScrolling in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

getAlign

@Nullable
public final EHCIFrameAlign getAlign()

Specified by:

getAlign in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setAlign

@Nonnull
public final IMPLTYPE setAlign(@Nullable
                               EHCIFrameAlign eAlign)

Specified by:

setAlign in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

isFrameBorder

public final boolean isFrameBorder()

Specified by:

isFrameBorder in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setFrameBorder

@Nonnull
public final IMPLTYPE setFrameBorder(boolean bFrameBorder)

Specified by:

setFrameBorder in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

getWidth

@Nullable
public final String getWidth()

Specified by:

getWidth in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setWidth

@Nonnull
public final IMPLTYPE setWidth(int nWidth)

Set the width in pixel

Specified by:

setWidth in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

Parameters:

nWidth - the width in pixel

Returns:

this

setWidthPercentage

@Nonnull
public final IMPLTYPE setWidthPercentage(double dPercentage)

Specified by:

setWidthPercentage in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

getHeight

@Nullable
public final String getHeight()

Specified by:

getHeight in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setHeight

@Nonnull
public final IMPLTYPE setHeight(int nHeight)

Specified by:

setHeight in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setHeightPercentage

@Nonnull
public final IMPLTYPE setHeightPercentage(double dPercentage)

Specified by:

setHeightPercentage in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

getMarginWidth

public final int getMarginWidth()

Specified by:

getMarginWidth in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setMarginWidth

@Nonnull
public final IMPLTYPE setMarginWidth(int nMarginWidth)

Specified by:

setMarginWidth in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

getMarginHeight

public final int getMarginHeight()

Specified by:

getMarginHeight in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setMarginHeight

@Nonnull
public final IMPLTYPE setMarginHeight(int nMarginHeight)

Specified by:

setMarginHeight in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

isSandbox

public final boolean isSandbox()

Specified by:

isSandbox in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

getSandboxAllow

@Nonnull
@ReturnsMutableCopy
public final EnumSet<EHCSandboxAllow> getSandboxAllow()

Specified by:

getSandboxAllow in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

setSandbox

@Nonnull
public final IMPLTYPE setSandbox(boolean bSandbox,
                                 @Nullable
                                 EHCSandboxAllow... aSandboxAllows)

Specified by:

setSandbox in interface IHCIFrame<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>>

getLoading

@Nullable
public final EHCLoadingType getLoading()

setLoading

@Nonnull
public final IMPLTYPE setLoading(@Nullable
                                 EHCLoadingType eLoading)

fillMicroElement

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 AbstractHCElementWithInternalChildren<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>,IHCNode>

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 AbstractHCElementWithInternalChildren<IMPLTYPE extends AbstractHCIFrame<IMPLTYPE>,IHCNode>