org.apache.wicket.markup.html.image

Class ExternalImage

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.markup.html.WebComponent

org.apache.wicket.markup.html.image.ExternalImage

All Implemented Interfaces:

Serializable, IEventSink, IEventSource, IConverterLocator, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

Direct Known Subclasses:

ExternalSource

public class ExternalImage
extends WebComponent

A component to display external images. The src / srcSet information are hold in models

Author:

Tobias Soloschenko, Sebastien Briquet, Sven Meier, Martin Grigorov

See Also:

Image, Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_AFTER_RENDERING, FLAG_INITIALIZED, FLAG_PREPARED_FOR_RENDER, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RENDERING, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING

Constructor Summary

Constructors

Constructor and Description
ExternalImage(String id) Creates an external image
ExternalImage(String id, IModel<Serializable> srcModel) Creates an external image
ExternalImage(String id, IModel<Serializable> srcModel, IModel<List<Serializable>> srcSetModel) Creates an external image
ExternalImage(String id, Serializable src) Creates an external image
ExternalImage(String id, Serializable src, List<Serializable> srcSet) Creates an external image

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildSizesAttribute(ComponentTag tag) builds the sizes attribute of the img tag
protected void	buildSrcAttribute(ComponentTag tag, IModel<?> srcModel) Builds the src attribute
protected void	buildSrcSetAttribute(ComponentTag tag, IModel<List<Serializable>> srcSetModel) Builds the srcset attribute if multiple models are found as varargs
Image.Cors	getCrossOrigin() Gets the cross origin settings
IModel<List<Serializable>>	getSrcSetModel() Gets a list of models containing the src set values
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
protected void	onDetach() Detaches the srcSetModels
void	removeSizes() Removes all sizes values.
void	removeXValues() Removes all x values from the image src set.
void	setCrossOrigin(Image.Cors crossOrigin) Sets the cross origin settings
void	setSizes(String... sizes)
void	setSrcSetModel(IModel<List<Serializable>> srcSetModel) Sets the source set model
void	setXValues(String... values)

Methods inherited from class org.apache.wicket.markup.html.WebComponent

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession, onRender

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, get, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalInitialize, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onAfterRenderChildren, onBeforeRender, onComponentTagBody, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModel, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, toString, toString, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ExternalImage

public ExternalImage(String id)

Creates an external image

Parameters:

id - the component id

ExternalImage

public ExternalImage(String id,
             Serializable src)

Creates an external image

Parameters:

id - the component id

src - the source URL

ExternalImage

public ExternalImage(String id,
             Serializable src,
             List<Serializable> srcSet)

Creates an external image

Parameters:

id - the component id

src - the source URL

srcSet - a list of URLs placed in the srcSet attribute

ExternalImage

public ExternalImage(String id,
             IModel<Serializable> srcModel)

Creates an external image

Parameters:

id - the component id

srcModel - the model source URL

ExternalImage

public ExternalImage(String id,
             IModel<Serializable> srcModel,
             IModel<List<Serializable>> srcSetModel)

Creates an external image

Parameters:

id - the component id

srcModel - the model source URL

srcSetModel - a model list of URLs placed in the srcSet attribute

Method Detail

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: Component

Processes the component tag. Overrides of this method most likely should call the super implementation.

Overrides:

onComponentTag in class Component

Parameters:

tag - Tag to modify

buildSrcAttribute

protected void buildSrcAttribute(ComponentTag tag,
                     IModel<?> srcModel)

Builds the src attribute

Parameters:

tag - the component tag

srcModel - the model containing the src URL

buildSrcSetAttribute

protected void buildSrcSetAttribute(ComponentTag tag,
                        IModel<List<Serializable>> srcSetModel)

Builds the srcset attribute if multiple models are found as varargs

Parameters:

tag - the component tag

srcSetModel - the models containing the src set URLs

buildSizesAttribute

protected void buildSizesAttribute(ComponentTag tag)

builds the sizes attribute of the img tag

Parameters:

tag - the component tag

setXValues

public void setXValues(String... values)

Parameters:

values - the x values to be used in the srcset

removeSizes

public void removeSizes()

Removes all sizes values. The corresponding tag will not be rendered anymore.

setSizes

public void setSizes(String... sizes)

Parameters:

sizes - the sizes to be used in the size

removeXValues

public void removeXValues()

Removes all x values from the image src set.

getCrossOrigin

public Image.Cors getCrossOrigin()

Gets the cross origin settings

Returns:

the cross origins settings

See Also:

org.apache.wicket.markup.html.image.Image#setCrossOrigin(Cors)}

setCrossOrigin

public void setCrossOrigin(Image.Cors crossOrigin)

Sets the cross origin settings

Parameters:

crossOrigin - the cross origins settings to set

See Also:

org.apache.wicket.markup.html.image.Image#setCrossOrigin(Cors)}

getSrcSetModel

public IModel<List<Serializable>> getSrcSetModel()

Gets a list of models containing the src set values

Returns:

a list of models containing the src set values

setSrcSetModel

public void setSrcSetModel(IModel<List<Serializable>> srcSetModel)

Sets the source set model

Parameters:

srcSetModel - the model of a list of src set entries

onDetach

protected void onDetach()

Detaches the srcSetModels

Overrides:

onDetach in class Component