/*
* Copyright (c) 2003, KNOPFLERFISH project
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following
* conditions are met:
*
* - Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* - Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* - Neither the name of the KNOPFLERFISH project nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.knopflerfish.service.desktop;
import org.osgi.framework.BundleContext;
import javax.swing.JComponent;
import javax.swing.Icon;
/**
*
* Interface for services wishing to become visible as components in
* the desktop Swing window.
*
*
* The desktop window can be extended by new components, displaying
* bundle details. To extend the desktop, create and register an instance
* of SwingBundleDisplayer.
*
*
* In fact, all internal views in the desktop bundle
* are created by such services.
*
*
* Service properties
*
* All SwingBundleDisplayer should be registered with a set of
* properties:
*
* - SwingBundleDisplayer.PROP_NAME (String)
* Short name of the displayer. Will typically be used
* in tab names or menu selections.
* - SwingBundleDisplayer.PROP_DESCRIPTION (String)
* Longer description of the displayer. Will typically be
* used as tooltip text.
* - SwingBundleDisplayer.PROP_ISDETAIL (Boolean)
* If Boolean.TRUE, the displayer provides components
* with high detail level for a single, selected bundles. Detail
* displayers are typically shown in the right-hand "info" part
* of the desktop window.
* If this property is not set, or equals Boolean.FALSE,
* the displayer can handle a view of all installed bundes. These
* displayers are typically shown in the left-hand "bundle" part
* of the desktop window.
*
*
*
*
* Additionally, displayers may provide an icon which will be displayed
* next to the name/description.
*
*
*
* The bundle selection is described by an BundleSelectionModel,
* and displayer should be prepared to display different content
* depending on which bundles are selected. To modify the selection
* (and thus update all other registered displayers), use the
* setSelection and clearSelection methods in the
* BundleSelectionModel
*
*
* Desktop usage of Bundle attributes
*
* When the desktop displays bundle information, some bundle
* attributes are used. The same method should be used by bundle
* displayers.
*
*
* - Bundle-Activator
*
- The Bundle-Activator is used to select from
* the built in "application" or "library" icons. If the
* bundle has a bundle activator set, the application icon
* is selected, otherwise the library icon.
*
*
- Application-Icon
*
- If Application-Icon is set to a resource name
* of an icon, this icon is used insead of the built in
* application of library icons. The icon is accessed using
* the bundle://[bundle id] URL scheme.
*
*/
public interface SwingBundleDisplayer {
/**
* Service Property (String)
*
* Value is org.knopflerfish.service.desktop.displayer.name
*
*/
public final static String PROP_NAME =
"org.knopflerfish.service.desktop.displayer.name";
/**
* Service Property (String)
*
* Value is org.knopflerfish.service.desktop.displayer.description
*
*/
public final static String PROP_DESCRIPTION =
"org.knopflerfish.service.desktop.displayer.description";
/**
* Service Property (Boolean)
*
* Value is org.knopflerfish.service.desktop.displayer.isdetail
*
*/
public final static String PROP_ISDETAIL =
"org.knopflerfish.service.desktop.displayer.isdetail";
/**
* Create the actual component that should be displayed.
*
*
* New components must be created for each createJComponent
* call.
*
*/
public JComponent createJComponent();
/**
* Perform any necessary cleanup operations.
*
* @param comp Component previously created by createJComponent
*/
public void disposeJComponent(JComponent comp);
/**
* @param model Selection model describing which bundles are
* selected. The actual bundle list must be managed
* by the displayer itself.
*/
public void setBundleSelectionModel(BundleSelectionModel model);
/**
* Get a large icon (48x48) for the displayer.
*
*
* null can be returned if no icon is provided.
*
*/
public Icon getLargeIcon();
/**
* Get a smaller icon (22x22) for the displayer.
*
*
* null can be returned if no icon is provided.
*
*/
public Icon getSmallIcon();
/**
* Allow access to another bundle context than the displayer's
* own. This might be used to set a remote bundle context.
*
*
* This method might never be called - the displayer should
* in that case use its own context. The normal case is to start
* with the displayer's own context and later switch to another
* context.
*
*
*
* If setTargetBundleContext is called, the displayer
* must update all components with this context.
*
*/
public void setTargetBundleContext(BundleContext bc);
}