org.apache.wicket.markup.html.form.validation
Class FormComponentFeedbackIndicator

java.lang.Object
  extended by org.apache.wicket.Component
      extended by org.apache.wicket.MarkupContainer
          extended by org.apache.wicket.markup.html.WebMarkupContainer
              extended by org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
                  extended by org.apache.wicket.markup.html.panel.Panel
                      extended by org.apache.wicket.markup.html.form.validation.FormComponentFeedbackIndicator
All Implemented Interfaces:
Serializable, IFeedback, IClusterable, IConverterLocator, IHeaderPartContainerProvider

public class FormComponentFeedbackIndicator
extends Panel
implements IFeedback

A panel that hides or shows itself depending on whether there are feedback messages for a given message filter. If a component is set using setIndicatorFor(Component), then the indicator is visible when the given component has an error. The default content for this indicator is a red star, but you can subclass this panel and provide your own markup to give any custom look you desire.

Author:
Jonathan Locke
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
FormComponentFeedbackIndicator(String id)
          Constructor
FormComponentFeedbackIndicator(String id, IModel<?> model)
          Deprecated. no need for a model in this component
 
Method Summary
protected  boolean callOnBeforeRenderIfNotVisible()
          Override this method if you want onBeforeRender to be called even when your component is not visible.
protected  IFeedbackMessageFilter getFeedbackMessageFilter()
           
 void onBeforeRender()
          Set the component's visibility according to the existence (or not) of feedback messages
 void setIndicatorFor(Component component)
           
 
Methods inherited from class org.apache.wicket.markup.html.panel.Panel
onComponentTag, onComponentTagBody, renderHead
 
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainerWithAssociatedMarkup
newHeaderPartContainer, renderHeadFromAssociatedMarkupFile
 
Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer
getMarkupType, getWebPage, getWebRequest
 
Methods inherited from class org.apache.wicket.MarkupContainer
add, addOrReplace, autoAdd, autoAdd, contains, findMarkupStream, get, get, getAssociatedMarkupStream, getMarkupStream, hasAssociatedMarkup, internalAdd, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onAfterRenderChildren, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, renderNext, replace, setDefaultModel, setMarkupStream, size, swap, toString, toString, visitChildren, visitChildren
 
Methods inherited from class org.apache.wicket.Component
add, addStateChange, afterRender, beforeRender, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, configure, continueToOriginalDestination, debug, detach, detachBehaviors, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, 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, onBeginRequest, onConfigure, onDetach, onEndRequest, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, prepareForRender, redirectToInterceptPage, remove, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, setAuto, setComponentBorder, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, 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

FormComponentFeedbackIndicator

public FormComponentFeedbackIndicator(String id)
Constructor

Parameters:
id - See Component

FormComponentFeedbackIndicator

@Deprecated
public FormComponentFeedbackIndicator(String id,
                                                 IModel<?> model)
Deprecated. no need for a model in this component

See Also:
Component.Component(String, IModel)
Method Detail

setIndicatorFor

public void setIndicatorFor(Component component)
Parameters:
component - The component to watch for messages

onBeforeRender

public void onBeforeRender()
Set the component's visibility according to the existence (or not) of feedback messages

Overrides:
onBeforeRender in class Component
See Also:
Component.callOnBeforeRenderIfNotVisible()

callOnBeforeRenderIfNotVisible

protected boolean callOnBeforeRenderIfNotVisible()
Description copied from class: Component
Override this method if you want onBeforeRender to be called even when your component is not visible. default this returns false.

Overrides:
callOnBeforeRenderIfNotVisible in class Component
Returns:
boolean, if true then onBeforeRender is called even for none visible components, default false.
See Also:
Component.onBeforeRender()

getFeedbackMessageFilter

protected IFeedbackMessageFilter getFeedbackMessageFilter()
Returns:
Let subclass specify some other filter


Copyright © 2004-2011 Apache Software Foundation. All Rights Reserved.