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

Class AbstractHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

java.lang.Object

com.helger.html.hc.impl.AbstractHCNode

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

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

com.helger.html.hc.html.embedded.AbstractHCImg<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>, IHCImg<IMPLTYPE>, IHCElement<IMPLTYPE>, IHCHasCSSClasses<IMPLTYPE>, IHCHasCSSStyles<IMPLTYPE>, IHCMediaElementChild<IMPLTYPE>, IHCHasID<IMPLTYPE>, IHCNode, Serializable

Direct Known Subclasses:

HCImg

public abstract class AbstractHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>
extends AbstractHCMediaElementChild<IMPLTYPE>
implements IHCImg<IMPLTYPE>

Represents an HTML <img> element

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

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

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	getAlt()
EHCCORSSettings	getCrossOrigin()
com.helger.commons.dimension.SizeInt	getExtent()
int	getHeight(int nDefaultValue)
EHCLoadingType	getLoading()
String	getSizes()
com.helger.commons.url.ISimpleURL	getSrc()
String	getSrcSet()
int	getWidth(int nDefaultValue)
boolean	hasExtent()
IMPLTYPE	scaleBestMatching(int nMaxWidth, int nMaxHeight)	Scales the image so that neither with nor height are exceeded, keeping the aspect ratio.
IMPLTYPE	scaleToHeight(int nNewHeight)
IMPLTYPE	scaleToWidth(int nNewWidth)
IMPLTYPE	setAlt(String sAlt)
IMPLTYPE	setCrossOrigin(EHCCORSSettings eCrossOrigin)
IMPLTYPE	setExtent(int nWidth, int nHeight)
IMPLTYPE	setExtent(com.helger.commons.dimension.SizeInt aExtent)
IMPLTYPE	setLoading(EHCLoadingType eLoading)
IMPLTYPE	setSizes(String sSizes)
IMPLTYPE	setSrc(com.helger.commons.url.ISimpleURL aSrc)
IMPLTYPE	setSrcSet(String sSrcSet)
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, 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

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

Constructor Detail

AbstractHCImg

public AbstractHCImg()

Method Detail

getSrc

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

Specified by:

getSrc in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

setSrc

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

Specified by:

setSrc in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

getSrcSet

@Nullable
public final String getSrcSet()

Specified by:

getSrcSet in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

setSrcSet

@Nonnull
public final IMPLTYPE setSrcSet(@Nullable
                                String sSrcSet)

Specified by:

setSrcSet in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

getSizes

@Nullable
public final String getSizes()

Specified by:

getSizes in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

setSizes

@Nonnull
public final IMPLTYPE setSizes(@Nullable
                               String sSizes)

Specified by:

setSizes in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

hasExtent

public final boolean hasExtent()

Specified by:

hasExtent in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

getWidth

public final int getWidth(int nDefaultValue)

Specified by:

getWidth in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

getHeight

public final int getHeight(int nDefaultValue)

Specified by:

getHeight in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

getExtent

@Nullable
public final com.helger.commons.dimension.SizeInt getExtent()

Specified by:

getExtent in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

setExtent

@Nonnull
public final IMPLTYPE setExtent(@Nullable
                                com.helger.commons.dimension.SizeInt aExtent)

Specified by:

setExtent in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

setExtent

@Nonnull
public final IMPLTYPE setExtent(@Nonnegative
                                int nWidth,
                                @Nonnegative
                                int nHeight)

Specified by:

setExtent in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

scaleToWidth

@Nonnull
public final IMPLTYPE scaleToWidth(@Nonnegative
                                   int nNewWidth)

Specified by:

scaleToWidth in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

scaleToHeight

@Nonnull
public final IMPLTYPE scaleToHeight(@Nonnegative
                                    int nNewHeight)

Specified by:

scaleToHeight in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

scaleBestMatching

@Nonnull
public final IMPLTYPE scaleBestMatching(@Nonnegative
                                        int nMaxWidth,
                                        @Nonnegative
                                        int nMaxHeight)

Scales the image so that neither with nor height are exceeded, keeping the aspect ratio.

Specified by:

scaleBestMatching in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

Parameters:

nMaxWidth - Maximum with

nMaxHeight - Maximum height

Returns:

the correctly resized image tag

getAlt

@Nullable
public final String getAlt()

Specified by:

getAlt in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

setAlt

@Nonnull
public final IMPLTYPE setAlt(@Nullable
                             String sAlt)

Specified by:

setAlt in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

getCrossOrigin

@Nullable
public final EHCCORSSettings getCrossOrigin()

Specified by:

getCrossOrigin in interface IHCImg<IMPLTYPE extends AbstractHCImg<IMPLTYPE>>

setCrossOrigin

@Nonnull
public final IMPLTYPE setCrossOrigin(@Nullable
                                     EHCCORSSettings eCrossOrigin)

Specified by:

setCrossOrigin in interface IHCImg<IMPLTYPE extends AbstractHCImg<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 AbstractHCElement<IMPLTYPE extends AbstractHCImg<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 AbstractHCImg<IMPLTYPE>>