Module org.apache.wicket.extensions
Package org.apache.wicket.extensions.markup.html.repeater.data.table

Class DataTable.Caption

java.lang.Object
org.apache.wicket.Component
org.apache.wicket.markup.html.WebComponent
org.apache.wicket.markup.html.basic.Label
org.apache.wicket.extensions.markup.html.repeater.data.table.DataTable.Caption
All Implemented Interfaces:
Serializable, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable
Enclosing class:
DataTable<T,S>
public static class DataTable.Caption extends Label
A caption for the table. It renders itself only if DataTable.getCaptionModel() has non-empty value.
See Also:

  • Constructor Details

    • Caption

      public Caption(String id, IModel<String> model)
      Construct.
      Parameters:
      id - the component id
      model - the caption model

  • Method Details

    • onConfigure

      protected void onConfigure()
      Description copied from class: Component
      Called on all components before any component is rendered. This method should be used to configure such things as visibility and enabled flags.

      Overrides must call super.onConfigure(), usually before any other code

      NOTE: Component hierarchy should not be modified inside this method, instead it should be done in Component.onBeforeRender()

      NOTE: Why this method is preferrable to directly overriding Component.isVisible() and Component.isEnabled()? Because those methods are called multiple times even for processing of a single request. If they contain expensive logic they can slow down the response time of the entire page. Further, overriding those methods directly on form components may lead to inconsistent or unexpected state depending on when those methods are called in the form processing workflow. It is a better practice to push changes to state rather than pull.

      NOTE: If component's visibility or another property depends on another component you may call other.configure() followed by other.isVisible() as mentioned in Component.configure() javadoc.

      NOTE: Why should Component.onBeforeRender() not be used for this? Because if a component's visibility is controlled inside Component.onBeforeRender(), once invisible the component will never become visible again.

      Overrides:
      onConfigure in class Component

    • initModel

      protected IModel<String> initModel()
      Description copied from class: Component
      Called when a null model is about to be retrieved in order to allow a subclass to provide an initial model.

      By default this implementation looks components in the parent chain owning a IComponentInheritedModel to provide a model for this component via IComponentInheritedModel.wrapOnInheritance(Component).

      For example a FormComponent has the opportunity to instantiate a model on the fly using its id and the containing Form's model, if the form holds a CompoundPropertyModel.

      Overrides:
      initModel in class Component
      Returns:
      The model