org.apache.wicket.devutils.debugbar.DebugBar Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.ops4j.pax.wicket.service Show documentation
Pax Wicket Service is an OSGi extension of the Wicket framework, allowing for dynamic loading and unloading of Wicket components and pageSources.
There is a newer version: 5.0.0
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.wicket.devutils.debugbar;

import java.util.ArrayList;
import java.util.List;

import org.apache.wicket.Application;
import org.apache.wicket.AttributeModifier;
import org.apache.wicket.Component;
import org.apache.wicket.MetaDataKey;
import org.apache.wicket.ResourceReference;
import org.apache.wicket.devutils.DevUtilsPanel;
import org.apache.wicket.markup.html.CSSPackageResource;
import org.apache.wicket.markup.html.JavascriptPackageResource;
import org.apache.wicket.markup.html.image.Image;
import org.apache.wicket.markup.html.list.ListItem;
import org.apache.wicket.markup.html.list.ListView;
import org.apache.wicket.model.AbstractReadOnlyModel;

/**
 * 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 {@link IDebugBarContributor} and
 * registering it with the debug bar.
 * 
 * @author Jeremy Thomerson 
 * @see IDebugBarContributor
 */
public class DebugBar extends DevUtilsPanel
{

    private static final MetaDataKey> CONTRIBS_META_KEY = new MetaDataKey>()
    {
        private static final long serialVersionUID = 1L;
    };

    private static final long serialVersionUID = 1L;

    public DebugBar(String id)
    {
        super(id);
        setMarkupId("wicketDebugBar");
        setOutputMarkupId(true);
        add(new AttributeModifier("class", true, new AbstractReadOnlyModel()
        {
            private static final long serialVersionUID = 1L;

            @Override
            public String getObject()
            {
                return "wicketDebugBar" + (DebugBar.this.hasErrorMessage() ? "Error" : "");
            }

        }));
        add(CSSPackageResource.getHeaderContribution(DebugBar.class, "wicket-debugbar.css"));
        add(JavascriptPackageResource.getHeaderContribution(DebugBar.class, "wicket-debugbar.js"));
        add(new Image("logo", new ResourceReference(DebugBar.class, "wicket.png")));
        add(new Image("removeImg", new ResourceReference(DebugBar.class, "remove.png")));
        List contributors = getContributors();
        
        // no longer necessary, registered from DebugBarInitializer
        // if (contributors.isEmpty())
        // {
        // we do this so that if you have multiple applications running in
        // the same container,
        // each ends up registering its' own contributors (wicket-examples
        // for example)
        // registerStandardContributors(Application.get());
        // contributors = getContributors();
        // }
        add(new ListView("contributors", contributors)
        {
            private static final long serialVersionUID = 1L;

            @Override
            protected void populateItem(ListItem item)
            {
                IDebugBarContributor contrib = item.getModelObject();
                Component comp = contrib.createComponent("contrib", DebugBar.this);
                if (comp == null)
                {
                    // some contributors only add information to the debug bar
                    // and don't actually create a contributed component
                    item.setVisibilityAllowed(false);
                }
                else
                {
                    item.add(comp);
                }
            }
        });
    }

    @Override
    public boolean isVisible()
    {
        return getApplication().getDebugSettings().isDevelopmentUtilitiesEnabled();
    }

    /**
     * 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.
     * 
     * @param application
     * @param contrib
     *            custom contributor - can not be null
     */
    public static void registerContributor(IDebugBarContributor contrib)
    {
        registerContributor(contrib, Application.get());
    }

    /**
     * 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.
     * 
     * @param application
     * @param contrib
     *            custom contributor - can not be null
     */
    public static void registerContributor(IDebugBarContributor contrib, Application application)
    {
        if (contrib == null)
        {
            throw new IllegalArgumentException("contrib can not be null");
        }

        List contributors = getContributors(application);
        contributors.add(contrib);
        application.setMetaData(CONTRIBS_META_KEY, contributors);
    }

    private static List getContributors()
    {
        return getContributors(Application.get());
    }

    private static List getContributors(Application application)
    {
        List list = application.getMetaData(CONTRIBS_META_KEY);
        return list == null ? new ArrayList() : list;
    }


    /**
     * Called from {@link DebugBarInitializer}
     */
    static void registerStandardContributors(Application application)
    {
        registerContributor(VersionDebugContributor.DEBUG_BAR_CONTRIB, application);
        registerContributor(InspectorDebugPanel.DEBUG_BAR_CONTRIB, application);
        registerContributor(SessionSizeDebugPanel.DEBUG_BAR_CONTRIB, application);
    }
}