org.sakaiproject.profile2.tool.components
Class FeedbackLabel

java.lang.Object
  extended by org.apache.wicket.Component
      extended by org.apache.wicket.markup.html.WebComponent
          extended by org.apache.wicket.markup.html.basic.Label
              extended by org.sakaiproject.profile2.tool.components.FeedbackLabel
All Implemented Interfaces:
Serializable, org.apache.wicket.IClusterable, org.apache.wicket.IConverterLocator

public class FeedbackLabel
extends org.apache.wicket.markup.html.basic.Label

Label displaying feedback messages for FormComponents.

You can use this Label to show the error message near the actual FormComponent, instead of in the FeedbackPanel It's safe to remove the FeedbackPanel if you use this class for every FormComponent in your Form.

You can use this code under Apache 2.0 license, as long as you retain the copyright messages. Tested with Wicket 1.3.4

Author:
Daan, StuQ.nl, Steve Swinsburg, s.swinsburg@lancaster.ac.uk
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.wicket.Component
org.apache.wicket.Component.ComponentModelChange, org.apache.wicket.Component.EnabledChange, org.apache.wicket.Component.IVisitor<T extends org.apache.wicket.Component>, org.apache.wicket.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, PATH_SEPARATOR, RENDER
 
Constructor Summary
FeedbackLabel(String id, org.apache.wicket.Component component)
          Call this constructor if you just want to display the FeedbackMessage of the component
FeedbackLabel(String id, org.apache.wicket.Component component, org.apache.wicket.model.IModel iModel)
          Call this constructor if you want to display a custom model (for easy i18n)
FeedbackLabel(String id, org.apache.wicket.Component component, String text)
          Call this constructor if you want to display a custom text
 
Method Summary
protected  void onBeforeRender()
          Set the content of this FeedbackLabel, depending on if the component has a FeedbackMessage.
 
Methods inherited from class org.apache.wicket.markup.html.basic.Label
onComponentTag, onComponentTagBody
 
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, 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, 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

FeedbackLabel

public FeedbackLabel(String id,
                     org.apache.wicket.Component component)
Call this constructor if you just want to display the FeedbackMessage of the component

Parameters:
id - The non-null id of this component
component - The FormComponent to show the FeedbackMessage for.

FeedbackLabel

public FeedbackLabel(String id,
                     org.apache.wicket.Component component,
                     String text)
Call this constructor if you want to display a custom text

Parameters:
id - The non-null id of this component
component - The FormComponent to show the custom text for.
text - The custom text to show when the FormComponent has a FeedbackMessage

FeedbackLabel

public FeedbackLabel(String id,
                     org.apache.wicket.Component component,
                     org.apache.wicket.model.IModel iModel)
Call this constructor if you want to display a custom model (for easy i18n)

Parameters:
id - The non-null id of this component
component - The FormComponent to show the custom model for.
iModel - The custom model to show when the FormComponent has a FeedbackMessage
Method Detail

onBeforeRender

protected void onBeforeRender()
Set the content of this FeedbackLabel, depending on if the component has a FeedbackMessage. The HTML class attribute will be filled with the error level of the feedback message. That way, you can easily style different messages differently. Examples: class = "feedbacklabel INFO" class = "feedbacklabel ERROR" class = "feedbacklabel DEBUG" class = "feedbacklabel FATAL"

Overrides:
onBeforeRender in class org.apache.wicket.Component
See Also:
Component


Copyright © 2008-2012 The Sakai Foundation. All Rights Reserved.