com.sas.console.plugins
Class AbstractNavigationPlugin

java.lang.Object
  |
  +--com.sas.console.plugins.AbstractPlugin
        |
        +--com.sas.console.plugins.AbstractNavigationPlugin

All Implemented Interfaces:

PluginInterface, PluginNavigationInterface

Direct Known Subclasses:

Plugin

public abstract class AbstractNavigationPlugin

extends AbstractPlugin

implements PluginNavigationInterface

This is a basic implementation of the PluginNavigationInterface.

Field Summary

protected NodeInterface	m_rootNode The root node for this Plug-in.
protected String	m_strCategoryID The category where this plugin should appear.

Fields inherited from class com.sas.console.plugins.AbstractPlugin

m_aboutInfo, m_console, m_icon, m_pluginListenerList, m_strDescription, m_strName

Fields inherited from interface com.sas.console.plugins.PluginNavigationInterface

APPLICATION, ENVIRONMENT, MAINTENANCE, MONITOR

Constructor Summary

AbstractNavigationPlugin(ConsoleInterface console)
Constructor

Method Summary

protected void	_setCategoryID(String strCategoryID) Sets the category context of this node to the existing categories.
String	getCategoryID() Returns the category contexts where this node appears.
NodeInterface	getRootNode() Returns the root node for the Plug-in.
String	getTooltip() Gets a tooltip to display in the navigation tree.
void	setRootNode(NodeInterface rootNode) Sets the root node for the Plug-in.
abstract boolean	supportsDropOperations() Tells whether or not the plugin accepts drop operations via Drag and Drop

Methods inherited from class com.sas.console.plugins.AbstractPlugin

addPluginChangeListener, dispose, firePluginChange, getAbout, getConsole, getDescription, getIcon, getIcon, getName, initPlugin, needsConnection, removePluginChangeListener, setDescription, setIcon, setName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sas.console.plugins.PluginInterface

addPluginChangeListener, firePluginChange, getAbout, getConsole, getIcon, needsConnection, removePluginChangeListener

Methods inherited from interface com.sas.plugins.PluginInterface

dispose, getDescription, getIcon, getName, initPlugin

Field Detail

m_strCategoryID

protected String m_strCategoryID

The category where this plugin should appear.

m_rootNode

protected NodeInterface m_rootNode

The root node for this Plug-in.

Constructor Detail

AbstractNavigationPlugin

public AbstractNavigationPlugin(ConsoleInterface console)

Constructor

Parameters:

console - the console interface

Method Detail

supportsDropOperations

public abstract boolean supportsDropOperations()

Tells whether or not the plugin accepts drop operations via Drag and Drop

Specified by:

supportsDropOperations in interface PluginNavigationInterface

Returns:

Whether or not plugin accepts drops

getCategoryID

public String getCategoryID()

Returns the category contexts where this node appears. Categories are used to subset plugins into logicaly similar areas.

Specified by:

getCategoryID in interface PluginNavigationInterface

Returns:

String representations of this node's category ID.

_setCategoryID

protected void _setCategoryID(String strCategoryID)

Sets the category context of this node to the existing categories. Categories are used to subset plugins into logicaly similar areas.

Parameters:

strCategoryID - String representation of this node's category.

getRootNode

public NodeInterface getRootNode()

Returns the root node for the Plug-in.

Specified by:

getRootNode in interface PluginNavigationInterface

Returns:

The plugin's root node.

setRootNode

public void setRootNode(NodeInterface rootNode)

Sets the root node for the Plug-in.

Parameters:

rootNode - The root node.

getTooltip

public String getTooltip()

Gets a tooltip to display in the navigation tree. The limit on these should be 20 characters. Longer strings will be truncated.

Specified by:

getTooltip in interface PluginNavigationInterface

Returns:

20 character or shorter string for a tooltip