edu.iu.iv.common.util
Class BasicURLPlugin

java.lang.Object
  |
  +--edu.iu.iv.common.util.BasicURLPlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

JavadocPlugin, LearningModulesPlugin, ReferencePagesPlugin, SoftwareArchitecturePlugin, UpdatePlugin

public class BasicURLPlugin

extends java.lang.Object

implements Plugin

A simple plugin used for creating new plugins that link to URLs. Developers wishing to create plugins with this need only extend this class and make a super call to the correct constructor in their no-arg constructor.

Author:

Team IVC

Constructor Summary

BasicURLPlugin(java.lang.String menuPath, java.lang.String description, java.lang.String url)

BasicURLPlugin(java.lang.String menuPath, java.lang.String description, java.lang.String url, javax.swing.Icon icon)

Method Summary

java.lang.String	getDefaultMenuPath() Gets this plugin's menu path, a "/"-delimited string which describes where in the GUI menu its menu item will be inserted.
java.lang.String	getDescription()
javax.swing.Icon	getMenuIcon() Gets the menu icon to be shown on the menu for this plugin.
PropertyMap	getPropertyMap() Gets the property map for this plugin which specifies additional properties of the plugin that can be gotten.
javax.swing.JInternalFrame	getView(java.lang.Object model) Returns a view of the data given.
boolean	supports(java.lang.Object model) Determines whether a model is supported by this plugin or not.
java.lang.String	unsupportedReason(java.lang.Object model) Retrieves the reason why a particular model is unsupported by this plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicURLPlugin

public BasicURLPlugin(java.lang.String menuPath,
                      java.lang.String description,
                      java.lang.String url)

Parameters:

menuPath - the menu path for the ivc menu.

description - a description of the url

url - the url to go to when this plugin is used.

BasicURLPlugin

public BasicURLPlugin(java.lang.String menuPath,
                      java.lang.String description,
                      java.lang.String url,
                      javax.swing.Icon icon)

Parameters:

menuPath - the menu path for the ivc menu.

description - a description of the url

url - the url to go to when this plugin is used.

icon - an optional icon to place next to the menu item in the ivc.

Method Detail

getPropertyMap

public PropertyMap getPropertyMap()

Description copied from interface: Plugin

Gets the property map for this plugin which specifies additional properties of the plugin that can be gotten.

Specified by:

getPropertyMap in interface Plugin

Returns:

a plugin property map from PluginProperty->Value

See Also:

Plugin.getPropertyMap()

getDefaultMenuPath

public java.lang.String getDefaultMenuPath()

Description copied from interface: Plugin

Gets this plugin's menu path, a "/"-delimited string which describes where in the GUI menu its menu item will be inserted. For example, "File/Save/To Database" places the menu item "To Database" in the "Save" submenu of the "File" top-level menu.

Specified by:

getDefaultMenuPath in interface Plugin

Returns:

this plugin's menu path

See Also:

Plugin.getDefaultMenuPath()

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface Plugin

Returns:

a description of this plugin

See Also:

Plugin.getDescription()

supports

public boolean supports(java.lang.Object model)

Description copied from interface: Plugin

Determines whether a model is supported by this plugin or not.

Specified by:

supports in interface Plugin

Parameters:

model - the model to check for support

Returns:

true if the given model is supported, false otherwise

See Also:

Plugin.supports(java.lang.Object)

unsupportedReason

public java.lang.String unsupportedReason(java.lang.Object model)

Description copied from interface: Plugin

Retrieves the reason why a particular model is unsupported by this plugin.

Specified by:

unsupportedReason in interface Plugin

Parameters:

model - the model to look up a reason for

Returns:

the reason the given model is unsupported

See Also:

Plugin.unsupportedReason(java.lang.Object)

getView

public javax.swing.JInternalFrame getView(java.lang.Object model)

Description copied from interface: Plugin

Returns a view of the data given. The model given, must be supported by the plugin. Some plugins may ignore the model given to it. You may return null if you wish for no interface to be shown (as is the case with some algorithms).

Specified by:

getView in interface Plugin

Parameters:

model - the model to get a view of or to be acted upon.

Returns:

a swing frame that can then be added to the IVC User Interface.

See Also:

Plugin.getView(java.lang.Object)

getMenuIcon

public javax.swing.Icon getMenuIcon()

Description copied from interface: Plugin

Gets the menu icon to be shown on the menu for this plugin.

Specified by:

getMenuIcon in interface Plugin

Returns:

this plugin's icon, or null if it has none

See Also:

Plugin.getMenuIcon()