org.carewebframework.plugin.infopanel.service

Class InfoPanelService

java.lang.Object

org.carewebframework.plugin.infopanel.service.InfoPanelService

public class InfoPanelService
extends Object

Static methods for interacting with an info panel.

Method Summary

Modifier and Type	Method and Description
static void	associateEvent(org.fujion.component.BaseComponent component, String eventName, IInfoPanel.Action action) Associate a generic event with an action on this component's container.
static IInfoPanel	findInfoPanel(ElementBase element) Finds the "nearest" active info panel.
static IInfoPanel	findInfoPanel(ElementBase element, boolean activeOnly) Finds the "nearest" info panel.
static IInfoPanel	findInfoPanel(ElementPlugin.PluginContainer container) Finds the "nearest" active info panel.
static IInfoPanel	findInfoPanel(ElementPlugin.PluginContainer container, boolean activeOnly) Finds the "nearest" info panel.
static List<ActionListener>	getActionListeners(org.fujion.component.BaseComponent component) Returns a list of events associated with a component.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

findInfoPanel

public static IInfoPanel findInfoPanel(ElementPlugin.PluginContainer container,
                                       boolean activeOnly)

Finds the "nearest" info panel.

Parameters:

container - The container from which to begin the search.

activeOnly - If true, only active info panels are considered.

Returns:

The nearest active info panel, or null if none found.

findInfoPanel

public static IInfoPanel findInfoPanel(ElementPlugin.PluginContainer container)

Finds the "nearest" active info panel.

Parameters:

container - The container from which to begin the search.

Returns:

The nearest active info panel, or null if none found.

findInfoPanel

public static IInfoPanel findInfoPanel(ElementBase element,
                                       boolean activeOnly)

Finds the "nearest" info panel.

Parameters:

element - The UI element from which to begin the search.

activeOnly - If true, only active info panels are considered.

Returns:

The nearest active info panel, or null if none found.

findInfoPanel

public static IInfoPanel findInfoPanel(ElementBase element)

Finds the "nearest" active info panel.

Parameters:

element - The UI element from which to begin the search.

Returns:

The nearest active info panel, or null if none found.

associateEvent

public static void associateEvent(org.fujion.component.BaseComponent component,
                                  String eventName,
                                  IInfoPanel.Action action)

Associate a generic event with an action on this component's container.

Parameters:

component - Component whose container is the target of an action.

eventName - The name of the generic event that will invoke the action.

action - The action to be performed.

getActionListeners

public static List<ActionListener> getActionListeners(org.fujion.component.BaseComponent component)

Returns a list of events associated with a component. Should only be used internally.

Parameters:

component - Component of interest.

Returns:

The list of associated events (may be null).