Module wicket.bootstrap.core

Package de.agilecoders.wicket.core.markup.html.bootstrap.form

Class FormGroup

java.lang.Object

org.apache.wicket.Component

org.apache.wicket.MarkupContainer

org.apache.wicket.markup.html.WebMarkupContainer

org.apache.wicket.markup.html.border.Border

de.agilecoders.wicket.core.markup.html.bootstrap.form.FormGroup

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IComponentResolver, IRequestableComponent, IHierarchical<Component>, IClusterable

public class FormGroup
extends Border

Simple form control group that is able to show a label, help text and feedback message additional to wrapped form element.

Author:

miha

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FormGroup.FeedbackMessageToCssClassNameTransformer	Transforms a FeedbackMessage to a css class name.
static enum	FormGroup.Size	Deprecated. Not supported by Bootstrap 4.

Nested classes/interfaces inherited from class org.apache.wicket.markup.html.border.Border

Border.BorderBodyContainer

Field Summary

Fields inherited from class org.apache.wicket.markup.html.border.Border

BODY, BORDER

Fields inherited from class org.apache.wicket.Component

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

Constructor Summary

Constructors

Constructor	Description
FormGroup(String id)	Construct.
FormGroup(String id, IModel<String> label)	Construct.
FormGroup(String id, IModel<String> label, IModel<String> help)	Construct.

Method Summary

Modifier and Type	Method	Description
protected void	addOutputMarkupId(List<FormComponent<?>> formComponents)	sets the output markup id flag to true for all given formComponents.
protected Component	newFeedbackMessageContainer(String id)	creates a new container for a feedback message
protected Function<FeedbackMessage,String>	newFeedbackMessageToCssClassNameTransformer()
protected Component	newHelpLabel(String id, IModel<String> model)	creates a new help label that contains a help message for the form field.
protected Component	newLabel(String id, IModel<String> model)	creates a new label
protected void	onComponentTag(ComponentTag tag)
protected void	onConfigure()
protected void	onInitialize()
FormGroup	size(FormGroup.Size size)	Deprecated. Not supported by Bootstrap 4.
FormGroup	useFormComponentLabel(boolean value)

Methods inherited from class org.apache.wicket.markup.html.border.Border

add, addDequeuedComponent, addOrReplace, addToBorder, canDequeueTag, findComponentToDequeue, getBodyContainer, getMarkup, getRegionMarkup, newMarkupSourcingStrategy, queue, queueToBorder, remove, remove, removeAll, removeFromBorder, replace, replaceInBorder, resolve

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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

autoAdd, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onRender, renderAll, renderAssociatedMarkup, renderNext, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, 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, getMarkupTag, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onBeforeRender, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, 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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

FormGroup

public FormGroup(String id)

Construct.

Parameters:

id - the wicket component id

FormGroup

public FormGroup(String id,
 IModel<String> label)

Construct.

Parameters:

id - the wicket component id

label - the label

FormGroup

public FormGroup(String id,
 IModel<String> label,
 IModel<String> help)

Construct.

Parameters:

id - the wicket component id

Method Details

useFormComponentLabel

public FormGroup useFormComponentLabel(boolean value)

Parameters:

value - whether to use form components label as control group label or not

Returns:

this instance for chaining

size

@Deprecated
public FormGroup size(FormGroup.Size size)

Deprecated.

Not supported by Bootstrap 4. Use InputBehavior.size(InputBehavior.Size) on the FormComponent instead.

sets the size of form-group

Parameters:

size - the size to use

Returns:

this instance for chaining

newFeedbackMessageToCssClassNameTransformer

protected Function<FeedbackMessage,String> newFeedbackMessageToCssClassNameTransformer()

Returns:

new function that transforms a FeedbackMessage to a css class name

newLabel

protected Component newLabel(String id,
 IModel<String> model)

creates a new label

Parameters:

id - the component id

model - the content model for this component

Returns:

new label

newFeedbackMessageContainer

protected Component newFeedbackMessageContainer(String id)

creates a new container for a feedback message

Parameters:

id - the component id

Returns:

new feedback message container

newHelpLabel

protected Component newHelpLabel(String id,
 IModel<String> model)

creates a new help label that contains a help message for the form field. This field will be set to invisible if there is no content.

Parameters:

id - the component id

model - the content model for this component

Returns:

new help label

onComponentTag

protected void onComponentTag(ComponentTag tag)

Overrides:

onComponentTag in class Component

onInitialize

protected void onInitialize()

Overrides:

onInitialize in class MarkupContainer

addOutputMarkupId

protected void addOutputMarkupId(List<FormComponent<?>> formComponents)

sets the output markup id flag to true for all given formComponents. This is necessary to reference them in a "for" attribute on client side.

Parameters:

formComponents - the form components to add the output markup id

onConfigure

protected void onConfigure()

Overrides:

onConfigure in class Border