org.ujorm.wicket.component.form.fields

Class EnumField<T extends Enum<T>>

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.panel.Panel

org.apache.wicket.markup.html.panel.GenericPanel<T>

org.ujorm.wicket.component.form.fields.Field<T>

org.ujorm.wicket.component.form.fields.EnumField<T>

All Implemented Interfaces:

Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.IConverterLocator, org.apache.wicket.IGenericComponent<T>, org.apache.wicket.IQueueRegion, 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 EnumField<T extends Enum<T>>
extends Field<T>

CheckBox field with a Label including a feedback message.

Author:

Pavel Ponec

See Also:

Serialized Form

Field Summary

Fields inherited from class org.ujorm.wicket.component.form.fields.Field

behaviors, CSS_REQUIRED, cssClass, DEFAULT_DELAY, feedback, key, PROPERTY_PREFIX, validators

Fields inherited from class org.apache.wicket.markup.html.panel.Panel

PANEL

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
EnumField(Key<U,T> key)
EnumField(Key<U,T> key, String cssClass)
EnumField(String componentId, Key<U,T> key, String cssClass)

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.wicket.markup.html.form.FormComponent	createInput(String componentId, org.apache.wicket.model.IModel<T> model) Create a new form input Component where the default key have got value from the key: "value." + EnumField.super.getKey().getFullName() + ".null" .
protected Object	getComboDisplayValue(T object) Get the value for displaying to an end user.
protected String	getComboIdValue(T object, int index) This method is called to get the id value of an object (used as the value attribute of a choice element) The id can be extracted from the object like a primary key, or if the list is stable you could just return a toString of the index.
List<T>	getItems() Get component items
org.apache.wicket.markup.html.form.IChoiceRenderer<T>	getRenderer() Choice Renderer
void	setRenderer(org.apache.wicket.markup.html.form.IChoiceRenderer<T> renderer) Choice Renderer

Methods inherited from class org.ujorm.wicket.component.form.fields.Field

addBehaviour, addBehaviourOnBlur, addCssStyle, addMaxLength, addValidator, addValidator, clearFeedbackMessages, createChangeBehaviour, createLabel, createLabelModel, getCssClass, getInput, getKey, getKeyName, getKeyName, getModelValue, getResourceLabelKey, getValidators, getVisibleModel, isEnabled, isRequired, onConfigure, onChange, onInitialize, onSuperInitialize, requestFocus, setEnabledInput, setFeedbackMessage, setModelValue, setVisibleModel, toString

Methods inherited from class org.apache.wicket.markup.html.panel.GenericPanel

getModel, getModelObject, setModel, setModelObject

Methods inherited from class org.apache.wicket.markup.html.panel.Panel

getRegionMarkup, newMarkupSourcingStrategy

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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findComponentToDequeue, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onAfterRenderChildren, onComponentTagBody, onDetach, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, canCallListenerInterfaceAfterExpiry, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onComponentTag, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, 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

Methods inherited from interface org.apache.wicket.IQueueRegion

dequeue, newDequeueContext

Constructor Detail

EnumField

public EnumField(Key<U,T> key)

EnumField

public EnumField(Key<U,T> key,
         String cssClass)

EnumField

public EnumField(String componentId,
         Key<U,T> key,
         String cssClass)

Method Detail

getRenderer

public org.apache.wicket.markup.html.form.IChoiceRenderer<T> getRenderer()

Choice Renderer

setRenderer

public void setRenderer(org.apache.wicket.markup.html.form.IChoiceRenderer<T> renderer)

Choice Renderer

createInput

protected org.apache.wicket.markup.html.form.FormComponent createInput(String componentId,
                                                           org.apache.wicket.model.IModel<T> model)

Create a new form input Component where the default key have got value from the key: "value." + EnumField.super.getKey().getFullName() + ".null" .

Overrides:

createInput in class Field<T extends Enum<T>>

getComboDisplayValue

protected Object getComboDisplayValue(T object)

Get the value for displaying to an end user.

Parameters:

object - the actual object

Returns:

the value meant for displaying to an end user

getComboIdValue

protected String getComboIdValue(T object,
                     int index)

This method is called to get the id value of an object (used as the value attribute of a choice element) The id can be extracted from the object like a primary key, or if the list is stable you could just return a toString of the index.

Note that the given index can be -1 if the object in question is not contained in the available choices.

Parameters:

object - The object for which the id should be generated

index - The index of the object in the choices list.

Returns:

String

getItems

public List<T> getItems()

Get component items