Examples of org.apache.wicket.Component

org.apache.wicket.Component
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 {@link MarkupContainer} that holds the Component, butdoes 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 {@link #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 path from the Page at the root of the component hierarchy to a given Component is simply the concatenation with colon 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 {@link #getPath()}. To get a Component path relative to the page that contains it, you can call {@link #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. {@link IComponentInstantiationListener}s are notified of component instantiation.
    {@link #onInitialize()} is called on the component as soon as the component is part of a page'scomponent tree. At this state the component is able to access its markup.
  - Request Handling - An incoming request is processed by a protocol request handler such as {@link WicketFilter}. An associated Application object creates {@link Session}, {@link Request} and {@link Response} objects for use by a given Component in updating its modeland rendering a response. These objects are stored inside a container called {@link RequestCycle}which is accessible via {@link Component#getRequestCycle()}. The convenience methods {@link Component#getRequest()}, {@link Component#getResponse()} and{@link Component#getSession()} provide easy access to the contents of this container.
  - Listener Invocation - If the request references an {@link IRequestListener} on anexisting Component (or one of its {@link Behavior}s, see below), that listener is notified, 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. See {@link Form} for anexample of a component which listens for events via {@link IFormSubmitListener}.
  - Rendering - Before a page or part of a page (in case of Ajax updates) is rendered, all containing components are able to prepare for rendering via two hook methods: {@link #onConfigure()} (regardless whether they are visible or not) and {@link #onBeforeRender()}(if visible only) .
    A markup response is generated by the Component via {@link Component#render()}, which calls subclass implementation code contained in {@link Component#onRender()}. Once this phase begins, a Component becomes immutable. Attempts to alter the Component will result in a WicketRuntimeException.
  - Detachment - Each request cycle finishes by detaching all touched components. Subclasses should clean up their state by overriding {@link #onDetach()} or more specifically{@link #detachModels()} if they keep references to models beside the default model.
- Visibility - If a component is not visible (see {@link #setVisible(boolean)}) it will not render a response (nor will their children).
- Enabling - Component subclasses take into account their enabled state (see {@link #setEnabled(boolean)} when rendering, and in case of a {@link FormComponent} will not notupdate its model while the request is handled.
- Models - The primary responsibility of a component is to use its model (an object that implements {@link IModel}) to render a response in an appropriate markup language, such as HTML. In addition, {@link FormComponent}s know how to update their models based on request information, see {@link FormComponent#updateModel()}. Since the IModel interface is a wrapper around another object, a convenience method {@link Component#getDefaultModelObject()} is provided to retrievethe object from its IModel wrapper. A further convenience method, {@link Component#getDefaultModelObjectAsString()}, is provided for the very common operation of converting the wrapped object to a String.
  The component's model can be passed in the constructor or set via {@link Component#setDefaultModel(IModel)}. In neither case a model can be created on demand with {@link #initModel()}.
  Note that a component can have more models besides its default model.
- Behaviors - You can add multiple {@link Behavior}s to any component if you need to dynamically alter the behavior of components, e.g. manipulate attributes of the markup tag to which a Component is attached. Behaviors take part in the component's lifecycle through various callback methods.
- Locale - The Locale for a Component is available through {@link #getLocale()}, which delegates to its parent's locale, finally consulting the {@link Session}'s locale.
- Style - The Session's style ("skin") is available through {@link org.apache.wicket.Component#getStyle()}. Styles are intended to give a particular look to all components or resources in a session 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 prefer these resources to other resources, such as default resources, which are not as good of a match.
- Variation - Whereas styles are Session (user) specific, variations are component specific. E.g. if the Style is "ocean" and {@link #getVariation()} returnss "NorthSea", than theresources are given the names suffixed with "_ocean_NorthSea".
- String Resources - Components can have associated String resources via the Application's Localizer, which is available through the method {@link Component#getLocalizer()}. The convenience methods {@link Component#getString(String key)} and{@link Component#getString(String key,IModel model)} wrap the identical methods on theApplication Localizer for easy access in Components.
- Feedback Messages - The {@link Component#debug(Serializable)}, {@link Component#info(Serializable)}, {@link Component#warn(Serializable)}, {@link Component#error(java.io.Serializable)} and {@link Component#fatal(Serializable)} methodsassociate feedback messages with a Component. It is generally not necessary to use these methods directly since Wicket validators automatically register feedback messages on Components. Feedback message for a given Component can be retrieved with {@link Component#getFeedbackMessages}.
- Versioning - Pages are the unit of versioning in Wicket, but fine-grained control of which Components should participate in versioning is possible via the {@link Component#setVersioned(boolean)} method. The versioning participation of a given Componentcan be retrieved with {@link Component#isVersioned()}.
- Page - The Page containing any given Component can be retrieved by calling {@link Component#getPage()}. If the Component is not attached to a Page, an IllegalStateException will be thrown. An equivalent method, {@link Component#findPage()} is available for specialcircumstances where it might be desirable to get a null reference back instead.
- Application - The {@link #getApplication()} method provides convenient access to the{@link Application} for a Component.
- AJAX support- Components can be re-rendered after the whole Page has been rendered at least once by calling doRender().
- Security - All components are subject to an {@link IAuthorizationStrategy} whichcontrols instantiation, visibility and enabling. See {@link SimplePageAuthorizationStrategy} fora simple implementation.

    tester.newFormTester("form").submit("ajaxButton");
    assertEquals("a text value", page.text);
    assertTrue(ajaxButtonSubmitted.get());


    assertFalse(ajaxSubmitLinkSubmitted.get());
    Component submitter = page.form.get("ajaxlink");
    tester.newFormTester("form").submit(submitter);
    assertEquals("a text value", page.text);
    assertTrue(ajaxSubmitLinkSubmitted.get());


    tester.clickLink("form:link");

View Full Code Here

   */
  @Test
  public void renderComponentRelativeErrorMessage()
  {
    tester.startPage(new ComponentFeedbackResourceTestingPage());
    Component label = tester.getComponentFromLastRenderedPage("label");
    tester.assertComponentFeedbackMessage(label, "error.msg", null, new ExactLevelFeedbackMessageFilter(FeedbackMessage.ERROR));
  }

View Full Code Here

   */
  @Test
  public void renderComponentRelativeInfoMessage()
  {
    tester.startPage(new ComponentFeedbackResourceTestingPage());
    Component label = tester.getComponentFromLastRenderedPage("label");
    tester.assertComponentFeedbackMessage(label, "info.msg", null, new ExactLevelFeedbackMessageFilter(FeedbackMessage.INFO));
  }

View Full Code Here

      return null;
    }


    final String id = tag.getAttribute(getWicketNamespace(markupStream) + WICKET_FOR).trim();


    Component component = findRelatedComponent(container, id);
    if (component == null)
    {
      throw new ComponentNotFoundException("Could not find form component with id '" + id +
        "' while trying to resolve wicket:for attribute");
    }


    if (!(component instanceof ILabelProvider))
    {
      throw new WicketRuntimeException("Component pointed to by wicket:for attribute '" + id +
        "' does not implement " + ILabelProvider.class.getName());
    }


    if (!component.getOutputMarkupId())
    {
      component.setOutputMarkupId(true);
      if (component.hasBeenRendered())
      {
        logger.warn(
          "Component: {} is referenced via a wicket:for attribute but does not have its outputMarkupId property set to true",
          component.toString(false));
      }
    }


    if (component instanceof FormComponent)
    {
      component.setMetaData(MARKER_KEY, new AutoLabelMarker((FormComponent<?>)component));
    }


    return new AutoLabel("label" + container.getPage().getAutoIndex(), component);
  }

View Full Code Here

   */
  static Component findRelatedComponent(MarkupContainer container, final String id)
  {
    // try the quick and easy route first


    Component component = container.get(id);
    if (component != null)
    {
      return component;
    }

View Full Code Here

      {
        path = componentIdPageId + path;
      }
    }


    Component component = getLastRenderedPage().get(path);
    if (component == null)
    {
      fail("path: '" + path + "' does not exist for page: " +
        Classes.simpleName(getLastRenderedPage().getClass()));
      return null;
    }


    if (!wantVisibleInHierarchy || component.isVisibleInHierarchy())
    {
      return component;
    }


    // Not found or not visible

View Full Code Here

   *            expected component class
   * @return a <code>Result</code>
   */
  public <C extends Component> Result isComponent(String path, Class<C> expectedComponentClass)
  {
    Component component = getComponentFromLastRenderedPage(path);
    if (component == null)
    {
      return Result.fail("Component not found: " + path);
    }


    return isTrue("component '" + Classes.simpleName(component.getClass()) + "' is not type:" +
      Classes.simpleName(expectedComponentClass),
      expectedComponentClass.isAssignableFrom(component.getClass()));
  }

View Full Code Here

   */
  public Result isVisible(final String path)
  {
    final Result result;


    Component component = getComponentFromLastRenderedPage(path, false);
    if (component == null)
    {
      result = Result.fail("path: '" + path + "' does no exist for page: " +
        Classes.simpleName(getLastRenderedPage().getClass()));
    }
    else
    {
      result = isTrue("component '" + path + "' is not visible",
        component.isVisibleInHierarchy());
    }


    return result;
  }

View Full Code Here

   */
  public Result isInvisible(final String path)
  {
    final Result result;


    Component component = getComponentFromLastRenderedPage(path, false);
    if (component == null)
    {
      result = Result.fail("path: '" + path + "' does no exist for page: " +
        Classes.simpleName(getLastRenderedPage().getClass()));
    }
    else
    {
      result = isFalse("component '" + path + "' is visible",
        component.isVisibleInHierarchy());
    }


    return result;
  }

View Full Code Here

   *            path to component
   * @return a <code>Result</code>
   */
  public Result isEnabled(final String path)
  {
    Component component = getComponentFromLastRenderedPage(path);
    if (component == null)
    {
      fail("path: '" + path + "' does no exist for page: " +
        Classes.simpleName(getLastRenderedPage().getClass()));
    }


    return isTrue("component '" + path + "' is disabled", component.isEnabledInHierarchy());
  }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.apache.wicket.Component

at.molindo.wicketutils.utils.MockRenderCallback

com.gitblit.wicket.panels.LinkPanel

com.gitblit.wicket.panels.RepositoryUrlPanel

com.inmethod.grid.common.AbstractGridRow

com.inmethod.grid.common.ColumnsHeaderRepeater

com.inmethod.grid.datagrid.DataGrid

com.inmethod.grid.treegrid.TreeGrid

de.agilecoders.wicket.core.markup.html.bootstrap.behavior.AssertTagNameBehaviorTest

de.agilecoders.wicket.core.markup.html.bootstrap.navbar.Navbar

de.agilecoders.wicket.core.util.BehaviorsTest

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.