org.apache.wicket.markup.html.basic
Class EnumLabel<T extends Enum<T>>

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.markup.html.WebComponent
          org.apache.wicket.markup.html.basic.EnumLabel<T>

Type Parameters:

T - enum type

All Implemented Interfaces:

Serializable, IClusterable, IConverterLocator

public class EnumLabel<T extends Enum<T>>
extends WebComponent

A Label component that is used to render an enum value. The value renderered will be the result of a i18n resource lookup of the following form: <value.getClass().getSimpleName()>.<value.name()>, this format can be changed by overriding resourceKey(Enum)

Author:

igor.vaynberg

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.IVisitor<T extends Component>, Component.VisibilityChange

Field Summary

Fields inherited from class org.apache.wicket.Component

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

Constructor Summary

EnumLabel(String id)
Constructor

EnumLabel(String id, IModel<T> model)

EnumLabel(String id, T value)
Convenience constructor.

Method Summary

IModel<T>	getModel() Gets model
T	getModelObject() Gets model object
protected String	nullValue()
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
protected void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Processes the body.
protected String	resourceKey(T value) Converts enum value into a resource key that should be used to lookup the text the label will display
void	setModel(IModel<T> model) Sets model
void	setModelObject(T object) Sets model object

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

onRender

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, callOnBeforeRenderIfNotVisible, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviors, getBehaviors, getBehaviorsRawList, getClassRelativePath, getComponentBorder, getConverter, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdImpl, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalAttach, internalDetach, internalOnAttach, internalOnDetach, internalOnModelChanged, isActionAuthorized, isAncestorOf, isAttached, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, locateMarkupStream, markAttached, markRendering, modelChanged, modelChanging, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModel, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMarkupStream, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, toString, toString, urlFor, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

EnumLabel

public EnumLabel(String id)

Constructor

Parameters:

id - See Component

EnumLabel

public EnumLabel(String id,
                 T value)

Convenience constructor. Same as Label(String, new Model<String>(String))

Parameters:

id - See Component

value - Enum value to render

See Also:

Component.Component(String, IModel)

EnumLabel

public EnumLabel(String id,
                 IModel<T> model)

Parameters:

id -

model -

See Also:

Component.Component(String, IModel)

Method Detail

onComponentTagBody

protected void onComponentTagBody(MarkupStream markupStream,
                                  ComponentTag openTag)

Description copied from class: Component

Processes the body.

Overrides:

onComponentTagBody in class Component

Parameters:

markupStream - The markup stream

openTag - The open tag for the body

See Also:

Component.onComponentTagBody(org.apache.wicket.markup.MarkupStream, org.apache.wicket.markup.ComponentTag)

resourceKey

protected String resourceKey(T value)

Converts enum value into a resource key that should be used to lookup the text the label will display

Parameters:

value -

Returns:

resource key

nullValue

protected String nullValue()

Returns:

value that should be displayed if model object is null

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

See Also:

Component.onComponentTag(org.apache.wicket.markup.ComponentTag)

getModel

public final IModel<T> getModel()

Gets model

Returns:

model

setModel

public final void setModel(IModel<T> model)

Sets model

Parameters:

model -

getModelObject

public final T getModelObject()

Gets model object

Returns:

model object

setModelObject

public final void setModelObject(T object)

Sets model object

Parameters:

object -