ro.sync.sample.plugin.customprotocol
Class CustomProtocolChooserExtension

java.lang.Object
  ro.sync.sample.plugin.customprotocol.CustomProtocolChooserExtension

All Implemented Interfaces:

PluginExtension, URLChooserMenuExtension, URLChooserPluginExtension2, URLChooserToolbarExtension

public class CustomProtocolChooserExtension
extends java.lang.Object
implements URLChooserPluginExtension2, URLChooserToolbarExtension

Plugin extension - custom protocol chooser extension

Constructor Summary

CustomProtocolChooserExtension()

Method Summary

java.net.URL[]	chooseURLs(StandalonePluginWorkspace workspaceAccess) Choose a set of URLs with the corresponding protocol.
java.lang.String	getMenuName() Get the plugin name that will be displayed on the menu
javax.swing.Icon	getToolbarIcon() Get the toolbar icon.
java.lang.String	getToolbarTooltip() Get the tooltip to be placed on the toolbar button.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomProtocolChooserExtension

public CustomProtocolChooserExtension()

Method Detail

chooseURLs

public java.net.URL[] chooseURLs(StandalonePluginWorkspace workspaceAccess)

Description copied from interface: URLChooserPluginExtension2

Choose a set of URLs with the corresponding protocol.

Specified by:

chooseURLs in interface URLChooserPluginExtension2

Parameters:

workspaceAccess - Access to the Oxygen workspace.

Returns:

The chosen array of URLs or null if the user rejects the selection.

See Also:

URLChooserPluginExtension2.chooseURLs(ro.sync.exml.workspace.api.standalone.StandalonePluginWorkspace)

getMenuName

public java.lang.String getMenuName()

Description copied from interface: URLChooserMenuExtension

Get the plugin name that will be displayed on the menu

Specified by:

getMenuName in interface URLChooserMenuExtension

Returns:

A menu name.

getToolbarIcon

public javax.swing.Icon getToolbarIcon()

Description copied from interface: URLChooserToolbarExtension

Get the toolbar icon. The action will be placed in the "File" toolbar. Return null if the action should not be included in the toolbar.

Specified by:

getToolbarIcon in interface URLChooserToolbarExtension

Returns:

The toolbar icon or null.

See Also:

URLChooserToolbarExtension.getToolbarIcon()

getToolbarTooltip

public java.lang.String getToolbarTooltip()

Description copied from interface: URLChooserToolbarExtension

Get the tooltip to be placed on the toolbar button. If the tooltip is null but there is an icon provided, the URLChooserPluginExtension.getMenuName() will be used instead.

Specified by:

getToolbarTooltip in interface URLChooserToolbarExtension

Returns:

The toolbar tooltip or null.

See Also:

URLChooserToolbarExtension.getToolbarTooltip()