|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.swing.AbstractAction
net.datacrow.core.plugin.Plugin
public abstract class Plugin
The Plugin class should be extended by every plugin.
Field Summary | |
---|---|
protected static int |
_INSERTTAB
|
protected static int |
_NOTETAB
|
protected static int |
_SEARCHTAB
|
Fields inherited from class javax.swing.AbstractAction |
---|
changeSupport, enabled |
Fields inherited from interface javax.swing.Action |
---|
ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, DISPLAYED_MNEMONIC_INDEX_KEY, LARGE_ICON_KEY, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SELECTED_KEY, SHORT_DESCRIPTION, SMALL_ICON |
Constructor Summary | |
---|---|
protected |
Plugin(DcObject dco,
DcTemplate template,
int viewIdx,
int moduleIdx)
Creates a new instance |
Method Summary | |
---|---|
abstract void |
actionPerformed(java.awt.event.ActionEvent ae)
|
void |
clear()
Free all resources. |
boolean |
equals(java.lang.Object o)
|
int |
getCurrentTab()
|
java.lang.String |
getHelpText()
The help text. |
abstract javax.swing.ImageIcon |
getIcon()
|
DcObject |
getItem()
Retrieves the item for which this plugin was called / created. |
java.lang.String |
getKey()
The unique key by which this plugin is referenced. |
javax.swing.KeyStroke |
getKeyStroke()
The key combination to active the plugin. |
java.lang.String |
getLabel()
The display label for this plugin. |
java.lang.String |
getLabelShort()
The short name of this plugin |
DcModule |
getModule()
Retrieves the module for which this plugin was called / created. |
int |
getModuleIdx()
Retrieves the module index for which this plugin was called / created. |
DcTemplate |
getTemplate()
|
View |
getView()
|
int |
getViewIdx()
Retrieves the view index from which this plugin was called / created. |
int |
getXpLevel()
The required user experience level. |
int |
hashCode()
|
boolean |
isAdminOnly()
Indicates if this plugin can only be used by an administrator. |
boolean |
isAuthorizable()
Indicates if a user can get special permissions in order to use this plugin. |
boolean |
isEnabled()
Indicates if the plugin is enabled. |
boolean |
isShowInMenu()
Indicates if the plugin should be shown in the menu bar. |
boolean |
isShowInPopupMenu()
Indicates if the plugin should be shown in the popup menu of the view. |
boolean |
isShowOnToolbar()
Indicates if the plugin should be shown on the toolbar. |
boolean |
isSystemPlugin()
Indicates if this plugin is part of the core Data Crow product. |
void |
setLabel(java.lang.String label)
Sets the label for this plugin. |
Methods inherited from class javax.swing.AbstractAction |
---|
addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, getValue, putValue, removePropertyChangeListener, setEnabled |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final int _SEARCHTAB
protected static final int _INSERTTAB
protected static final int _NOTETAB
Constructor Detail |
---|
protected Plugin(DcObject dco, DcTemplate template, int viewIdx, int moduleIdx)
dco
- The item for which the plugin is being created (or null)template
- The template to be used (or null)viewIdx
- The view index from which this plugin is being called / createdmoduleIdx
- The module index to which this plugin belongsMethod Detail |
---|
public int getXpLevel()
UserMode
public boolean isAdminOnly()
public int getViewIdx()
public View getView()
public DcObject getItem()
public DcTemplate getTemplate()
public java.lang.String getLabelShort()
public final int getCurrentTab()
public final int getModuleIdx()
public final DcModule getModule()
public java.lang.String getHelpText()
public javax.swing.KeyStroke getKeyStroke()
public void setLabel(java.lang.String label)
label
- public java.lang.String getLabel()
public void clear()
public final java.lang.String getKey()
public boolean isSystemPlugin()
public boolean isShowOnToolbar()
public boolean isShowInPopupMenu()
public boolean isShowInMenu()
public boolean isAuthorizable()
public boolean isEnabled()
isEnabled
in interface javax.swing.Action
isEnabled
in class javax.swing.AbstractAction
public abstract javax.swing.ImageIcon getIcon()
public abstract void actionPerformed(java.awt.event.ActionEvent ae)
public final boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public final int hashCode()
hashCode
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |