Package org.apache.wicket.markup.html.form

Class AutoLabelResolver

java.lang.Object

org.apache.wicket.markup.html.form.AutoLabelResolver

All Implemented Interfaces:

java.io.Serializable, IComponentResolver, org.apache.wicket.util.io.IClusterable

public class AutoLabelResolver
extends java.lang.Object
implements IComponentResolver

Resolver that implements the wicket:for attribute functionality. The attribute makes it easy to set up <label> tags for form components by providing the following features without having to add any additional components in code:

• Outputs the for attribute with the value equivalent to the markup id of the referenced form component
• Appends required css class to the <label> tag if the referenced form component is required. Name of the css class can be overwritten by having a i18n property defined for key AutoLabel.CSS.required
• Appends error css class to the <label> tag if the referenced form component has failed validation. Name of the css class can be overwritten by having a i18n property defined for key AutoLabel.CSS.error
• Appends disabled css class to the <label> tag if the referenced form component has is not enabled in hierarchy. Name of the css class can be overwritten by having a i18n property defined for key AutoLabel.CSS.disabled

The value of the wicket:for attribute can either contain an id of the form component or a path to it using the standard : path separator. Note that .. can be used as part of the path to construct a reference to the parent container, eg ..:..:foo:bar. First the value of the attribute will be treated as a path and the <label> tag's closest parent container will be queried for the form component. If the form component cannot be resolved the value of the wicket:for attribute will be treated as an id and all containers will be searched from the closest parent to the page.

Author:

igor, Carl-Eric Menzel

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	AutoLabelResolver.AutoLabel	Component that is attached to the <label> tag and takes care of writing out the label text as well as setting classes on the <label> tag
static class	AutoLabelResolver.AutoLabelMarker	Marker used to track whether or not a form component has an associated auto label by its mere presense as well as some attributes of the component across requests.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CSS_DISABLED_KEY
static java.lang.String	CSS_ERROR_KEY
static java.lang.String	CSS_REQUIRED_KEY
static java.lang.String	LABEL_ATTR
static MetaDataKey<AutoLabelResolver.AutoLabelMarker>	MARKER_KEY

Constructor Summary

Constructors

Constructor	Description
AutoLabelResolver()

Method Summary

Modifier and Type	Method	Description
static java.lang.String	getLabelIdFor(Component component)
Component	resolve(MarkupContainer container, MarkupStream markupStream, ComponentTag tag)	Try to resolve a component.

Methods inherited from class java.lang.Object

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

Field Detail

LABEL_ATTR

public static final java.lang.String LABEL_ATTR

See Also:

Constant Field Values

CSS_REQUIRED_KEY

public static final java.lang.String CSS_REQUIRED_KEY

CSS_DISABLED_KEY

public static final java.lang.String CSS_DISABLED_KEY

CSS_ERROR_KEY

public static final java.lang.String CSS_ERROR_KEY

MARKER_KEY

public static final MetaDataKey<AutoLabelResolver.AutoLabelMarker> MARKER_KEY

Constructor Detail

AutoLabelResolver

public AutoLabelResolver()

Method Detail

resolve

public Component resolve(MarkupContainer container,
                         MarkupStream markupStream,
                         ComponentTag tag)

Description copied from interface: IComponentResolver

Try to resolve a component.

Specified by:

resolve in interface IComponentResolver

Parameters:

container - The container parsing its markup

markupStream - The current markupStream

tag - The current component tag while parsing the markup

Returns:

component or null if not found

getLabelIdFor

public static java.lang.String getLabelIdFor(Component component)