wicket
Class Component

java.lang.Object
  wicket.Component

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

MarkupContainer, WebComponent

public abstract class Component

extends java.lang.Object

implements java.io.Serializable

Component serves as the highest level abstract base class for all components.

• Identity - All Components must have a non-null id which is retrieved by calling getId(). The id must be unique within the MarkupContainer that holds the Component, but does not have to be globally unique or unique within a Page's component hierarchy.
• Hierarchy - A component has a parent which can be retrieved with getParent(). If a component is an instance of MarkupContainer, it may have children. In this way it has a place in the hierarchy of components contained on a given page. The isAncestorOf(Component)method returns true if this Component is an ancestor of the given Component.
• Component Paths - The path from the Page at the root of the component hierarchy to a given Component is simply the concatenation with dot separators of each id along the way. For example, the path "a.b.c" would refer to the component named "c" inside the MarkupContainer named "b" inside the container named "a". The path to a component can be retrieved by calling getPath(). This path is an absolute path beginning with the id of the Page at the root. Pages bear a PageMap/Session-relative identifier as their id, so each absolute path will begin with a number, such as "0.a.b.c". To get a Component path relative to the page that contains it, you can call getPageRelativePath().
• LifeCycle - Components participate in the following lifecycle phases:
  • Construction - A Component is constructed with the Java language new operator. Children may be added during construction if the Component is a MarkupContainer.
  • Cluster Attachment - When a Component is freshly replicated in a clustered environment, it may need to initialize transient state. This is possible by overriding the onSessionAttach()method.
  • Request Handling - An incoming request is processed by a protocol request handler such as WicketServlet. An associated Application object creates Session, Request and Response objects for use by a given Component in updating its model and rendering a response. These objects are stored inside a container called RequestCyclewhich is accessible via getRequestCycle(). The convenience methods getRequest(),getResponse()and getSession()provide easy access to the contents of this container.
  • Listener Invocation - If the request references a listener on an existing Component, that listener is called, allowing arbitrary user code to handle events such as link clicks or form submits. Although arbitrary listeners are supported in Wicket, the need to implement a new class of listener is unlikely for a web application and even the need to implement a listener interface directly is highly discouraged. Instead, calls to listeners are routed through logic specific to the event, resulting in calls to user code through other overridable methods. For example, the IFormSubmitListener.onFormSubmitted()method implemented by the Form class is really a private implementation detail of the Form class that is not designed to be overridden (although unfortunately, it must be public since all interface methods in Java must be public). Instead, Form subclasses should override user-oriented methods such as onValidate(), onSubmit() and onError() (although only the latter two are likely to be overridden in practice).
  • onBeginRequest - The onBeginRequest()method is called.
  • Form Submit - If a Form has been submitted and the Component is a FormComponent, the component's model is validated by a call to FormComponent.validate().
  • Form Model Update - If a valid Form has been submitted and the Component is a FormComponent, the component's model is updated by a call to FormComponent.updateModel().
  • Rendering - A markup response is generated by the Component via render(), which calls subclass implementation code contained in onRender(). Once this phase begins, a Component becomes immutable. Attempts to alter the Component will result in a WicketRuntimeException.
  • onEndRequest () - The onEndRequest()method is called.
• Component Models - The primary responsibility of a component is to use its model (an object that implements IModel), which can be set via setModel(IModel model)and retrieved via getModel(), to render a response in an appropriate markup language, such as HTML. In addition, form components know how to update their models based on request information. Since the IModel interface is a wrapper around an actual model object, a convenience method getModelObject()is provided to retrieve the model Object from its IModel wrapper. A further convenience method, getModelObjectAsString(), is provided for the very common operation of converting the wrapped model Object to a String.
• Visibility - Components which have setVisible(false) will return false from isVisible() and will not render a response (nor will their children).
• Page - The Page containing any given Component can be retrieved by calling getPage(). If the Component is not attached to a Page, an IllegalStateException will be thrown. An equivalent method, findPage()is available for special circumstances where it might be desirable to get a null reference back instead.
• Session - The Page for a Component points back to the Session that contains the Page. The Session for a component can be accessed with the convenience method getSession(), which simply calls getPage().getSession().
• Locale - The Locale for a Component is available through the convenience method getLocale(), which is equivalent to getSession().getLocale().
• String Resources - Components can have associated String resources via the Application's Localizer, which is available through the method getLocalizer(). The convenience methods getString(String key)and getString(String key, IModel model)wrap the identical methods on the Application Localizer for easy access in Components.
• Style - The style ("skin") for a component is available through getStyle(), which is equivalent to getSession().getStyle(). Styles are intended to give a particular look to a Component or Resource that is independent of its Locale. For example, a style might be a set of resources, including images and markup files, which gives the design look of "ocean" to the user. If the Session's style is set to "ocean" and these resources are given names suffixed with "_ocean", Wicket's resource management logic will be prefer these resources to other resources, such as default resources, which are not as good of a match.
• AttributeModifiers - You can add one or more AttributeModifiers to any component if you need to programmatically manipulate attributes of the markup tag to which a Component is attached.
• Application, ApplicationSettings and ApplicationPages - The getApplication() method provides convenient access to the Application for a Component via getSession().getApplication(). The getApplicationSettings() method is equivalent to getApplication().getSettings(). The getApplicationPages is equivalent to getApplication().getPages().
• Feedback Messages - The debug(String), info(String),warn(String), error(String)and fatal(String)methods associate feedback messages with a Component. It is generally not necessary to use these methods directly since Wicket validators automatically register feedback messages on Components. Any feedback message for a given Component can be retrieved with getFeedbackMessage().
• Page Factory - It is possible to change the way that Pages are constructed by overriding the getPageFactory()method, returning your own implementation of IPageFactory.
• Versioning - Pages are the unit of versioning in Wicket, but fine-grained control of which Components should participate in versioning is possible via the setVersioned(boolean)method. The versioning participation of a given Component can be retrieved with isVersioned().

  Author:

  Jonathan Locke, Chris Turner, Eelco Hillenius, Johan Compagner

  See Also:

  Serialized Form

  Nested Class Summary

  class	Component.ComponentModelChange Change record of a model.
  static interface	Component.IVisitor Generic component visitor interface for component traversals.
  protected class	Component.VisibilityChange A visibility change operation.

  Field Summary

  protected static short	FLAG_RESERVED1 Reserved subclass-definable flag bit
  protected static short	FLAG_RESERVED2 Reserved subclass-definable flag bit
  protected static short	FLAG_RESERVED3 Reserved subclass-definable flag bit
  protected static short	FLAG_RESERVED4 Reserved subclass-definable flag bit

  Constructor Summary

  Component(java.lang.String id)
  Constructor.

  Component(java.lang.String id, IModel model)
  Constructor.

  Method Summary

  Component	add(AttributeModifier modifier) Adds an attribute modifier to the component.
  protected void	addStateChange(Change change) Adds state change to page.
  protected void	checkComponentTag(ComponentTag tag, java.lang.String name) Checks whether the given type has the expected name.
  protected void	checkComponentTagAttribute(ComponentTag tag, java.lang.String key, java.lang.String value) Checks that a given tag has a required attribute value.
  void	debug(java.lang.String message) Registers a debug message for this component
  protected void	detachModel() Detaches the model for this component if it is detachable.
  void	error(java.lang.String message) Registers an error message for this component
  protected java.lang.String	exceptionMessage(java.lang.String message) Prefixes an exception message with useful information about this.
  void	fatal(java.lang.String message) Registers an fatal error message for this component
  protected MarkupStream	findMarkupStream() Finds the markup stream for this component.
  protected Page	findPage() If this Component is a Page, returns self.
  MarkupContainer	findParent(java.lang.Class c) Finds the first container parent of this component of the given class.
  MarkupContainer	findParentWithAssociatedMarkup()
  Application	getApplication() Gets interface to application that this component is a part of.
  ApplicationPages	getApplicationPages() Gets the application pages from the application that this component belongs to.
  ApplicationSettings	getApplicationSettings() Gets the application settings from the application that this component belongs to.
  java.lang.String	getClassRelativePath()
  IConverter	getConverter() Gets the converter that should be used by this component.
  boolean	getEscapeModelStrings() Gets whether model strings should be escaped.
  FeedbackMessage	getFeedbackMessage()
  protected boolean	getFlag(short flag) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  java.lang.String	getId() Gets the id of this component.
  java.util.Locale	getLocale() Gets the locale for the session holding this component.
  Localizer	getLocalizer() Convenience method to provide easy access to the localizer object within any component.
  IModel	getModel() Gets the model.
  java.lang.Object	getModelObject() Gets the backing model object; this is shorthand for getModel().getObject().
  java.lang.String	getModelObjectAsString() Gets a model object as a string.
  Page	getPage() Gets the page holding this component.
  IPageFactory	getPageFactory()
  java.lang.String	getPageRelativePath() Gets the path to this component relative to the page it is in.
  MarkupContainer	getParent() Gets any parent container, or null if there is none.
  java.lang.String	getPath() Gets the components' path.
  protected boolean	getRenderBodyOnly() If false the component's tag will be printed as well as its body (which is default).
  Request	getRequest()
  RequestCycle	getRequestCycle() Gets the active request cycle for this component
  Resource	getResource()
  Response	getResponse()
  Session	getSession() Gets the current session object.
  java.lang.String	getString(java.lang.String key)
  java.lang.String	getString(java.lang.String key, IModel model)
  java.lang.String	getString(java.lang.String key, IModel model, java.lang.String defaultValue)
  java.lang.String	getStyle() Gets the style of this component (see Session).
  boolean	hasErrorMessage()
  boolean	hasFeedbackMessage()
  void	info(java.lang.String message) Registers a info message for this component
  protected IModel	initModel() Called when a null model is about to be retrieved in order to allow a subclass to provide an initial model.
  protected void	internalBeginRequest() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  protected void	internalEndRequest() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  protected void	internalOnBeginRequest() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  protected void	internalOnEndRequest() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  protected void	internalOnModelChanged() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  protected void	internalOnModelChanging() THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  boolean	isAncestorOf(Component component) Returns true if this component is an ancestor of the given component
  boolean	isVersioned()
  boolean	isVisible() Gets whether this component and any children are visible.
  boolean	isVisibleInHierarchy() Checks if the component itself and all its parents are visible.
  void	modelChanged() Called to indicate that the model content for this component has been changed
  void	modelChanging() Called to indicate that the model content for this component is about to change
  Page	newPage(java.lang.Class c) Creates a new page using the component's page factory
  Page	newPage(java.lang.Class c, PageParameters parameters) Creates a new page using the component's page factory
  protected void	onBeginRequest() Called when a request begins.
  protected void	onComponentTag(ComponentTag tag) Processes the component tag.
  protected void	onComponentTagBody(MarkupStream markupStream, ComponentTag openTag) Processes the body.
  protected void	onEndRequest() Called when a request ends.
  protected void	onModelChanged() Called anytime a model is changed after the change has occurred
  protected void	onModelChanging() Called anytime a model is changed, but before the change actually occurs
  protected abstract void	onRender() Implementation that renders this component.
  protected void	onSessionAttach() Called when this component is deserialized as part of session replication
  protected void	redirectTo(Page page) Redirects browser to the given page.
  void	remove() Removes this component from its parent.
  void	render() Performs a render of this component.
  protected void	renderComponent(MarkupStream markupStream) Renders the component at the current position in the given markup stream.
  protected void	renderComponentTag(ComponentTag tag) Writes a simple tag out to the response stream.
  void	rendered() Called to indicate that a component has been rendered.
  protected void	replaceComponentTagBody(MarkupStream markupStream, ComponentTag tag, java.lang.String body) Replaces the body with the given one.
  boolean	sameRootModel(Component component)
  boolean	sameRootModel(IModel model)
  protected void	setFlag(short flag, boolean set) THIS METHOD IS NOT PART OF THE WICKET PUBLIC API.
  void	setModel(IModel model) Sets the given model.
  void	setModelObject(java.lang.Object object) Sets the backing model object; shorthand for getModel().setObject(object).
  void	setRedirect(boolean redirect)
  void	setRenderBodyOnly(boolean renderTag) If false the component's tag will be printed as well as its body (which is default).
  void	setResponsePage(Page page) Sets the page that will respond to this request
  Component	setShouldEscapeModelStrings(boolean escapeMarkup) Sets whether model strings should be escaped.
  void	setVersioned(boolean versioned)
  Component	setVisible(boolean visible) Sets whether this component and any children are visible.
  java.lang.String	toString() Gets the string representation of this component.
  java.lang.String	toString(boolean detailed)
  java.lang.String	urlFor(java.lang.Class listenerInterface)
  protected java.lang.Object	visitParents(java.lang.Class c, Component.IVisitor visitor) Visits the parents of this component.
  void	warn(java.lang.String message) Registers a warning message for this component.

  Methods inherited from class java.lang.Object

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

  Field Detail

  FLAG_RESERVED1

  protected static final short FLAG_RESERVED1

  Reserved subclass-definable flag bit

  See Also:

  Constant Field Values

  FLAG_RESERVED2

  protected static final short FLAG_RESERVED2

  Reserved subclass-definable flag bit

  See Also:

  Constant Field Values

  FLAG_RESERVED3

  protected static final short FLAG_RESERVED3

  Reserved subclass-definable flag bit

  See Also:

  Constant Field Values

  FLAG_RESERVED4

  protected static final short FLAG_RESERVED4

  Reserved subclass-definable flag bit

  See Also:

  Constant Field Values

  Constructor Detail

  Component

  public Component(java.lang.String id)

  Constructor. All components have names. A component's id cannot be null. This is the minimal constructor of component. It does not register a model.

  Parameters:

  id - The non-null id of this component

  Throws:

  WicketRuntimeException - Thrown if the component has been given a null id.

  Component

  public Component(java.lang.String id,
                   IModel model)

  Constructor. All components have names. A component's id cannot be null. This is constructor includes a model.

  Parameters:

  id - The non-null id of this component

  model - The component's model

  Throws:

  WicketRuntimeException - Thrown if the component has been given a null id.

  Method Detail

  add

  public final Component add(AttributeModifier modifier)

  Adds an attribute modifier to the component.

  Parameters:

  modifier - The attribute modifier to be added

  Returns:

  this (to allow method call chaining)

  debug

  public final void debug(java.lang.String message)

  Registers a debug message for this component

  Parameters:

  message - The message

  error

  public final void error(java.lang.String message)

  Registers an error message for this component

  Parameters:

  message - The message

  fatal

  public final void fatal(java.lang.String message)

  Registers an fatal error message for this component

  Parameters:

  message - The message

  findParent

  public final MarkupContainer findParent(java.lang.Class c)

  Finds the first container parent of this component of the given class.

  Parameters:

  c - MarkupContainer class to search for

  Returns:

  First container parent that is an instance of the given class, or null if none can be found

  findParentWithAssociatedMarkup

  public final MarkupContainer findParentWithAssociatedMarkup()

  Returns:

  The nearest markup container with associated markup

  getApplication

  public final Application getApplication()

  Gets interface to application that this component is a part of.

  Returns:

  The application associated with the session that this component is in.

  See Also:

  Application

  getApplicationPages

  public final ApplicationPages getApplicationPages()

  Gets the application pages from the application that this component belongs to.

  Returns:

  The application pages

  See Also:

  ApplicationPages

  getApplicationSettings

  public final ApplicationSettings getApplicationSettings()

  Gets the application settings from the application that this component belongs to.

  Returns:

  The application settings from the application that this component belongs to

  See Also:

  ApplicationSettings

  getClassRelativePath

  public final java.lang.String getClassRelativePath()

  Returns:

  A path of the form .

  See Also:

  getPageRelativePath()

  getConverter

  public IConverter getConverter()

  Gets the converter that should be used by this component.

  Returns:

  The converter that should be used by this component

  getEscapeModelStrings

  public final boolean getEscapeModelStrings()

  Gets whether model strings should be escaped.

  Returns:

  Returns whether model strings should be escaped

  getFeedbackMessage

  public final FeedbackMessage getFeedbackMessage()

  Returns:

  Any feedback message for this component

  getId

  public final java.lang.String getId()

  Gets the id of this component.

  Returns:

  The id of this component

  getLocale

  public final java.util.Locale getLocale()

  Gets the locale for the session holding this component.

  Returns:

  The locale for the session holding this component

  See Also:

  getSession()

  getLocalizer

  public final Localizer getLocalizer()

  Convenience method to provide easy access to the localizer object within any component.

  Returns:

  The localizer object

  getModel

  public IModel getModel()

  Gets the model. It returns the object that wraps the backing model.

  Returns:

  The model

  getModelObject

  public final java.lang.Object getModelObject()

  Gets the backing model object; this is shorthand for getModel().getObject().

  Returns:

  the backing model object

  getModelObjectAsString

  public final java.lang.String getModelObjectAsString()

  Gets a model object as a string.

  Returns:

  Model object for this component as a string

  getPage

  public final Page getPage()

  Gets the page holding this component.

  Returns:

  The page holding this component

  getPageFactory

  public final IPageFactory getPageFactory()

  Returns:

  The page factory for the session that this component is in

  getPageRelativePath

  public final java.lang.String getPageRelativePath()

  Gets the path to this component relative to the page it is in.

  Returns:

  The path to this component relative to the page it is in

  getParent

  public final MarkupContainer getParent()

  Gets any parent container, or null if there is none.

  Returns:

  Any parent container, or null if there is none

  getPath

  public final java.lang.String getPath()

  Gets the components' path.

  Returns:

  Dotted path to this component in the component hierarchy

  getRequest

  public final Request getRequest()

  Returns:

  The request for this component's active request cycle

  getRequestCycle

  public final RequestCycle getRequestCycle()

  Gets the active request cycle for this component

  Returns:

  The request cycle

  getResource

  public final Resource getResource()

  Returns:

  The shared resource for this component

  getResponse

  public final Response getResponse()

  Returns:

  The response for this component's active request cycle

  getSession

  public final Session getSession()

  Gets the current session object. Although this method is not final (because Page overrides it), it is not intended to be overridden by clients and clients of the framework should not do so!

  Returns:

  The session that this component is in

  getString

  public final java.lang.String getString(java.lang.String key)

  Parameters:

  key - Key of string resource in property file

  Returns:

  The String

  See Also:

  Localizer

  getString

  public final java.lang.String getString(java.lang.String key,
                                          IModel model)

  Parameters:

  key - The resource key

  model - The model

  Returns:

  The formatted string

  See Also:

  Localizer

  getString

  public final java.lang.String getString(java.lang.String key,
                                          IModel model,
                                          java.lang.String defaultValue)

  Parameters:

  key - The resource key

  model - The model

  defaultValue - A default value if the string cannot be found

  Returns:

  The formatted string

  See Also:

  Localizer

  getStyle

  public final java.lang.String getStyle()

  Gets the style of this component (see Session).

  Returns:

  The style of this component.

  See Also:

  Session, Session.getStyle()

  hasErrorMessage

  public final boolean hasErrorMessage()

  Returns:

  True if this component has an error message

  hasFeedbackMessage

  public final boolean hasFeedbackMessage()

  Returns:

  True if this component has some kind of feedback message

  info

  public final void info(java.lang.String message)

  Registers a info message for this component

  Parameters:

  message - The message

  isAncestorOf

  public final boolean isAncestorOf(Component component)

  Returns true if this component is an ancestor of the given component

  Parameters:

  component - The component to check

  Returns:

  True if the given component has this component as an ancestor

  isVersioned

  public boolean isVersioned()

  Returns:

  Returns the isVersioned.

  isVisibleInHierarchy

  public final boolean isVisibleInHierarchy()

  Checks if the component itself and all its parents are visible.

  Returns:

  true if the component and all its parents are visible.

  isVisible

  public boolean isVisible()

  Gets whether this component and any children are visible.

  Returns:

  True if component and any children are visible

  modelChanged

  public final void modelChanged()

  Called to indicate that the model content for this component has been changed

  modelChanging

  public final void modelChanging()

  Called to indicate that the model content for this component is about to change

  newPage

  public final Page newPage(java.lang.Class c)

  Creates a new page using the component's page factory

  Parameters:

  c - The class of page to create

  Returns:

  The new page

  newPage

  public final Page newPage(java.lang.Class c,
                            PageParameters parameters)

  Creates a new page using the component's page factory

  Parameters:

  c - The class of page to create

  parameters - Any parameters to pass to the constructor

  Returns:

  The new page

  remove

  public final void remove()

  Removes this component from its parent. It's important to remember that a component that is removed cannot be referenced from the markup still.

  render

  public final void render()

  Performs a render of this component.

  rendered

  public final void rendered()

  Called to indicate that a component has been rendered. This method should only very rarely be called at all. One usage is in ImageMap, which renders its link children its own special way (without calling render() on them). If ImageMap did not call rendered() to indicate that its child components were actually rendered, the framework would think they had never been rendered, and in development mode this would result in a runtime exception.

  sameRootModel

  public final boolean sameRootModel(Component component)

  Parameters:

  component - The component to compare with

  Returns:

  True if the given component's model is the same as this component's model.

  sameRootModel

  public final boolean sameRootModel(IModel model)

  Parameters:

  model - The model to compare with

  Returns:

  True if the given component's model is the same as this component's model.

  setModel

  public void setModel(IModel model)

  Sets the given model.

  Parameters:

  model - the model

  setModelObject

  public final void setModelObject(java.lang.Object object)

  Sets the backing model object; shorthand for getModel().setObject(object).

  Parameters:

  object - The object to set

  setRedirect

  public final void setRedirect(boolean redirect)

  Parameters:

  redirect - True if the response should be redirected to

  See Also:

  RequestCycle.setRedirect(boolean)

  setRenderBodyOnly

  public final void setRenderBodyOnly(boolean renderTag)

  If false the component's tag will be printed as well as its body (which is default). If true only the body will be printed, but not the component's tag.

  Parameters:

  renderTag - If true, the component tag will not be printed

  getRenderBodyOnly

  protected final boolean getRenderBodyOnly()

  If false the component's tag will be printed as well as its body (which is default). If true only the body will be printed, but not the component's tag.

  Returns:

  If true, the component tag will not be printed

  setResponsePage

  public final void setResponsePage(Page page)

  Sets the page that will respond to this request

  Parameters:

  page - The response page

  See Also:

  RequestCycle.setResponsePage(Page)

  setShouldEscapeModelStrings

  public final Component setShouldEscapeModelStrings(boolean escapeMarkup)

  Sets whether model strings should be escaped.

  Parameters:

  escapeMarkup - True is model strings should be escaped

  Returns:

  This

  setVersioned

  public void setVersioned(boolean versioned)

  Parameters:

  versioned - True to turn on versioning for this component, false to turn it off for this component and any children.

  setVisible

  public final Component setVisible(boolean visible)

  Sets whether this component and any children are visible.

  Parameters:

  visible - True if this component and any children should be visible

  Returns:

  This

  toString

  public java.lang.String toString()

  Gets the string representation of this component.

  Returns:

  The path to this component

  toString

  public java.lang.String toString(boolean detailed)

  Parameters:

  detailed - True if a detailed string is desired

  Returns:

  The string

  urlFor

  public final java.lang.String urlFor(java.lang.Class listenerInterface)

  Parameters:

  listenerInterface - The listener interface that the URL should call

  Returns:

  The URL

  See Also:

  Page.urlFor(Component, Class)

  warn

  public final void warn(java.lang.String message)

  Registers a warning message for this component.

  Parameters:

  message - The message

  addStateChange

  protected final void addStateChange(Change change)

  Adds state change to page.

  Parameters:

  change - The change

  checkComponentTag

  protected final void checkComponentTag(ComponentTag tag,
                                         java.lang.String name)

  Checks whether the given type has the expected name.

  Parameters:

  tag - The tag to check

  name - The expected tag name

  Throws:

  MarkupException - Thrown if the tag is not of the right name

  checkComponentTagAttribute

  protected final void checkComponentTagAttribute(ComponentTag tag,
                                                  java.lang.String key,
                                                  java.lang.String value)

  Checks that a given tag has a required attribute value.

  Parameters:

  tag - The tag

  key - The attribute key

  value - The required value for the attribute key

  Throws:

  MarkupException - Thrown if the tag does not have the required attribute value

  detachModel

  protected void detachModel()

  Detaches the model for this component if it is detachable.

  exceptionMessage

  protected final java.lang.String exceptionMessage(java.lang.String message)

  Prefixes an exception message with useful information about this. component.

  Parameters:

  message - The message

  Returns:

  The modified message

  findMarkupStream

  protected MarkupStream findMarkupStream()

  Finds the markup stream for this component.

  Returns:

  The markup stream for this component. Since a Component cannot have a markup stream, we ask this component's parent to search for it.

  findPage

  protected final Page findPage()

  If this Component is a Page, returns self. Otherwise, searches for the nearest Page parent in the component hierarchy. If no Page parent can be found, null is returned.

  Returns:

  The Page or null if none can be found

  getFlag

  protected final boolean getFlag(short flag)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT!

  Parameters:

  flag - The flag to test

  Returns:

  True if the flag is set

  initModel

  protected IModel initModel()

  Called when a null model is about to be retrieved in order to allow a subclass to provide an initial model. This gives FormComponent, for example, an opportunity to instantiate a model on the fly using the containing Form's model.

  Returns:

  The model

  internalBeginRequest

  protected void internalBeginRequest()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE. Called when a request begins.

  internalEndRequest

  protected void internalEndRequest()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE. Called when a request ends.

  internalOnBeginRequest

  protected void internalOnBeginRequest()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE. Called when a request begins.

  internalOnEndRequest

  protected void internalOnEndRequest()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE. Called when a request ends.

  internalOnModelChanged

  protected void internalOnModelChanged()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE. Called anytime a model is changed via setModel or setModelObject.

  internalOnModelChanging

  protected void internalOnModelChanging()

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT CALL OR OVERRIDE. Called anytime a model is changed via setModel or setModelObject.

  onBeginRequest

  protected void onBeginRequest()

  Called when a request begins.

  onComponentTag

  protected void onComponentTag(ComponentTag tag)

  Processes the component tag.

  Parameters:

  tag - Tag to modify

  onComponentTagBody

  protected void onComponentTagBody(MarkupStream markupStream,
                                    ComponentTag openTag)

  Processes the body.

  Parameters:

  markupStream - The markup stream

  openTag - The open tag for the body

  onEndRequest

  protected void onEndRequest()

  Called when a request ends.

  onModelChanged

  protected void onModelChanged()

  Called anytime a model is changed after the change has occurred

  onModelChanging

  protected void onModelChanging()

  Called anytime a model is changed, but before the change actually occurs

  onRender

  protected abstract void onRender()

  Implementation that renders this component.

  onSessionAttach

  protected void onSessionAttach()

  Called when this component is deserialized as part of session replication

  redirectTo

  protected void redirectTo(Page page)

  Redirects browser to the given page. NOTE: Usually, you should never call this method directly, but work with setResponsePage instead. This method is part of Wicket's internal behaviour and should only be used when you want to circumvent the normal framework behaviour and issue the redirect directly.

  Parameters:

  page - The page to redirect to

  renderComponent

  protected final void renderComponent(MarkupStream markupStream)

  Renders the component at the current position in the given markup stream. The method onComponentTag() is called to allow the component to mutate the start tag. The method onComponentTagBody() is then called to permit the component to render its body.

  Parameters:

  markupStream - The markup stream

  renderComponentTag

  protected final void renderComponentTag(ComponentTag tag)

  Writes a simple tag out to the response stream. Any components that might be referenced by the tag are ignored. Also undertakes any tag attribute modifications if they have been added to the component.

  Parameters:

  tag - The tag to write

  replaceComponentTagBody

  protected final void replaceComponentTagBody(MarkupStream markupStream,
                                               ComponentTag tag,
                                               java.lang.String body)

  Replaces the body with the given one.

  Parameters:

  markupStream - The markup stream to replace the tag body in

  tag - The tag

  body - The new markup

  setFlag

  protected final void setFlag(short flag,
                               boolean set)

  THIS METHOD IS NOT PART OF THE WICKET PUBLIC API. DO NOT USE IT!

  Parameters:

  flag - The flag to set

  set - True to turn the flag on, false to turn it off

  visitParents

  protected final java.lang.Object visitParents(java.lang.Class c,
                                                Component.IVisitor visitor)

  Visits the parents of this component.

  Parameters:

  c - Class

  visitor - The visitor to call at each parent of the given type

  Returns:

  First non-null value returned by visitor callback