de.agilecoders.wicket.markup.html.bootstrap.image

Class Icon

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

de.agilecoders.wicket.markup.html.bootstrap.image.Icon

All Implemented Interfaces:

Invertible<Icon>, Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.IClusterable

public class Icon
extends org.apache.wicket.markup.html.WebMarkupContainer
implements Invertible<Icon>

An Icon component displays a non localizable image resource.

Version:

1.0

Author:

miha

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Constructors

Constructor and Description
Icon(IconType type)
Icon(org.apache.wicket.model.IModel<IconType> type)
Icon(String id, IconType type)
Icon(String componentId, org.apache.wicket.model.IModel<IconType> type)

Method Summary

Methods

Modifier and Type	Method and Description
IconType	getType()
boolean	hasIconType()
Icon	invert() marks the icon as inverted.
boolean	isInverted()
Icon	setInverted(boolean value) marks the icon as inverted or not.
Icon	setType(IconType iconType) sets a new icon type
IconType	type() Deprecated. please use getType() instead.

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

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, 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, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onComponentTag, onConfigure, onDetach, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, 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

Icon

public Icon(String componentId,
    org.apache.wicket.model.IModel<IconType> type)

Parameters:

componentId - The non-null id of a new component

type - The type of the icon, e.g. Search, Home, User,...

Icon

public Icon(org.apache.wicket.model.IModel<IconType> type)

Icon

public Icon(String id,
    IconType type)

Icon

public Icon(IconType type)

Method Detail

isInverted

public boolean isInverted()

Returns:

true, if the icon color is inverted

setInverted

public Icon setInverted(boolean value)

marks the icon as inverted or not.

Specified by:

setInverted in interface Invertible<Icon>

Parameters:

value - true, if inverted version should be used

Returns:

the component's current instance

invert

public Icon invert()

marks the icon as inverted.

Returns:

the component's current instance

setType

public final Icon setType(IconType iconType)

sets a new icon type

Returns:

this instance for chaining

hasIconType

public final boolean hasIconType()

Returns:

true, if an IconType is set and it's not equal to IconType.Null

getType

public IconType getType()

Returns:

current icon type

type

public IconType type()

Deprecated. please use getType() instead.

Returns:

current icon type