Module org.apache.wicket.devutils
Package org.apache.wicket.devutils.debugbar

Class DebugBar

java.lang.Object
org.apache.wicket.Component
org.apache.wicket.MarkupContainer
org.apache.wicket.markup.html.WebMarkupContainer
org.apache.wicket.markup.html.panel.Panel
org.apache.wicket.devutils.DevUtilsPanel
org.apache.wicket.devutils.debugbar.DebugBar
All Implemented Interfaces:
Serializable, Iterable<Component>, IEventSink, IEventSource, IFeedbackContributor, IConverterLocator, IMetadataContext<Serializable,Component>, IQueueRegion, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable
public class DebugBar extends DevUtilsPanel
The debug bar is for use during development. It allows contributors to add useful functions or data, making them readily accessible to the developer.

To use it, simply add it to your base page so that all of your pages automatically have it.

Java: add(new DebugBar("debug")); HTML: <div wicket:id="debug"></div>
You can also add your own information to the bar by creating a IDebugBarContributor and registering it with the debug bar.

The debug bar uses CSS absolute positioning to appear in the top-right corner of the page. Important: if there is an element with a z-index in this part of your page, the DebugBar will need a higher "z-index" style value to show up. Or you can use different position for it. See wicket-debugbar.css.

Author:
Jeremy Thomerson
See Also:

  • Constructor Details

    • DebugBar

      public DebugBar(String id)
      Construct.

      Create debug bar (initially expanded)

      Parameters:
      id - component id
      See Also:

    • DebugBar

      public DebugBar(String id, boolean initiallyExpanded)
      Construct.
      Parameters:
      id - component id
      initiallyExpanded - true to show debug bar initially expanded
      See Also:

  • Method Details

    • positionBottom

      public DebugBar positionBottom()
      Positions the DebugBar at the bottom of the page
      Returns:

    • isVisible

      public boolean isVisible()
      Description copied from class: Component
      Gets whether this component and any children are visible.

      WARNING: this method can be called multiple times during a request. If you override this method, it is a good idea to keep it cheap in terms of processing. Alternatively, you can call Component.setVisible(boolean).

      Overrides:
      isVisible in class Component
      Returns:
      True if component and any children are visible

    • renderHead

      public void renderHead(IHeaderResponse response)
      Description copied from class: Component
      Render to the web response whatever the component wants to contribute to the head section.
      Specified by:
      renderHead in interface IHeaderContributor
      Overrides:
      renderHead in class Component
      Parameters:
      response - Response object

    • registerContributor

      public static void registerContributor(IDebugBarContributor contrib)
      Register your own custom contributor that will be part of the debug bar. You must have the context of an application for this thread at the time of calling this method.
      Parameters:
      contrib - custom contributor - can not be null

    • registerContributor

      public static void registerContributor(IDebugBarContributor contrib, Application application)
      Register your own custom contributor that will be part of the debug bar. You must have the context of an application for this thread at the time of calling this method.
      Parameters:
      application -
      contrib - custom contributor - can not be null

    • getContributors

      public static List<IDebugBarContributor> getContributors(Application application)

    • setContributors

      public static void setContributors(List<IDebugBarContributor> contributors, Application application)