Package org.apache.wicket.devutils.debugbar

Class DebugBar

  • All Implemented Interfaces:
    Serializable, Iterable<org.apache.wicket.Component>, org.apache.wicket.event.IEventSink, org.apache.wicket.event.IEventSource, org.apache.wicket.feedback.IFeedbackContributor, org.apache.wicket.IConverterLocator, org.apache.wicket.IMetadataContext<Serializable,​org.apache.wicket.Component>, org.apache.wicket.IQueueRegion, org.apache.wicket.markup.html.IHeaderContributor, org.apache.wicket.request.component.IRequestableComponent, org.apache.wicket.util.IHierarchical<org.apache.wicket.Component>, org.apache.wicket.util.io.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:
    IDebugBarContributor, Serialized Form

    • Field Summary

      • Fields inherited from class org.apache.wicket.markup.html.panel.Panel

        PANEL

      • Fields inherited from class org.apache.wicket.Component

        ENABLE, FLAG_INITIALIZED, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

    • Constructor Summary

      Constructors 
      Constructor Description
      DebugBar​(String id)
      Construct.
      DebugBar​(String id, boolean initiallyExpanded)
      Construct.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static List<IDebugBarContributor> getContributors​(org.apache.wicket.Application application)  
      boolean isVisible()  
      DebugBar positionBottom()
      Positions the DebugBar at the bottom of the page
      static void registerContributor​(IDebugBarContributor contrib)
      Register your own custom contributor that will be part of the debug bar.
      static void registerContributor​(IDebugBarContributor contrib, org.apache.wicket.Application application)
      Register your own custom contributor that will be part of the debug bar.
      void renderHead​(org.apache.wicket.markup.head.IHeaderResponse response)  
      static void setContributors​(List<IDebugBarContributor> contributors, org.apache.wicket.Application application)  

      • Methods inherited from class org.apache.wicket.markup.html.panel.Panel

        getRegionMarkup, newMarkupSourcingStrategy

      • Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

        getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

      • Methods inherited from class org.apache.wicket.MarkupContainer

        add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onDetach, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

      • Methods inherited from class org.apache.wicket.Component

        add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMarkupTag, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, onAfterRender, onComponentTag, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

      • Methods inherited from interface org.apache.wicket.IQueueRegion

        dequeue, newDequeueContext

    • Constructor Detail

      • DebugBar

        public DebugBar​(String id)
        Construct.

        Create debug bar (initially expanded)

        Parameters:
        id - component id
        See Also:
        DebugBar(String, boolean)

      • DebugBar

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

    • Method Detail

      • positionBottom

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

      • isVisible

        public boolean isVisible()
        Overrides:
        isVisible in class org.apache.wicket.Component

      • renderHead

        public void renderHead​(org.apache.wicket.markup.head.IHeaderResponse response)
        Specified by:
        renderHead in interface org.apache.wicket.markup.html.IHeaderContributor
        Overrides:
        renderHead in class org.apache.wicket.Component

      • 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,
                                       org.apache.wicket.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​(org.apache.wicket.Application application)

      • setContributors

        public static void setContributors​(List<IDebugBarContributor> contributors,
                                   org.apache.wicket.Application application)