org.argouml.application.helpers
Class SettingsTabHelper

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--org.argouml.application.helpers.SettingsTabHelper

All Implemented Interfaces:

javax.accessibility.Accessible, ArgoModule, java.awt.image.ImageObserver, java.awt.MenuContainer, Pluggable, PluggableSettingsTab, java.io.Serializable, SettingsTabPanel

Direct Known Subclasses:

SettingsTabAppearance, SettingsTabEnvironment, SettingsTabLayout, SettingsTabNotation, SettingsTabPreferences, SettingsTabUser

public abstract class SettingsTabHelper

extends javax.swing.JPanel

implements SettingsTabPanel, PluggableSettingsTab

Helper object for Settings Tabs

Since:

0.9.4

See Also:

Serialized Form

Field Summary

protected java.lang.String	_bundle String naming the resource bundle to use for localization.
static java.lang.String	SETTINGS_BUNDLE Default localization key for Settings

Fields inherited from class javax.swing.JPanel

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Container

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface org.argouml.application.api.Pluggable

PLUGIN_PREFIX, PLUGIN_TITLE, PLUGIN_VENDOR

Fields inherited from interface org.argouml.application.api.ArgoModule

cat, MODULEFILENAME, MODULEFILENAME_ALTERNATE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

SettingsTabHelper()
Constructor gets passed the localizer bundle name and a property change listener.

Method Summary

protected javax.swing.JCheckBox	createCheckBox(java.lang.String key) Create a localized JCheckBox.
protected javax.swing.JLabel	createLabel(java.lang.String key) Create a localized JLabel.
protected javax.swing.JRadioButton	createRadioButton(javax.swing.ButtonGroup bg, java.lang.String key, boolean selected) Create a localized JRadioButton.
protected javax.swing.JTextField	createTextField() Create a JTextField.
java.util.Vector	getModulePopUpActions(java.util.Vector v, java.lang.Object o) Calls all modules to let them add to a popup menu.
SettingsTabPanel	getSettingsTabPanel() Returns the settings tab panel for the plugin.
javax.swing.JPanel	getTabPanel() Returns the JPanel which implements the tab.
java.lang.String	getTabResourceBundleKey() Returns the name of the resource bundle to use.
boolean	inContext(java.lang.Object[] o) A function which allows a plug-in to decide if it is available under a specific context.
boolean	initializeModule() Method called when Argo is loading a module.
boolean	isModuleEnabled() Allows determination if a module is enabled or disabled
java.lang.String	localize(java.lang.String key) Helper for localization, localizes using the bundle passed in the constructor.
void	setModuleEnabled(boolean v) Called to enable or disable a module programmatically.
boolean	shutdownModule() Method called when Argo is unloading a module.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.argouml.application.api.SettingsTabPanel

getTabKey, handleSettingsTabCancel, handleSettingsTabRefresh, handleSettingsTabSave

Methods inherited from interface org.argouml.application.api.ArgoModule

getModuleAuthor, getModuleDescription, getModuleKey, getModuleName, getModuleVersion

Field Detail

SETTINGS_BUNDLE

public static final java.lang.String SETTINGS_BUNDLE

Default localization key for Settings

See Also:

Constant Field Values

_bundle

protected java.lang.String _bundle

String naming the resource bundle to use for localization.

Constructor Detail

SettingsTabHelper

public SettingsTabHelper()

Constructor gets passed the localizer bundle name and a property change listener.

Method Detail

localize

public java.lang.String localize(java.lang.String key)

Helper for localization, localizes using the bundle passed in the constructor.

createLabel

protected javax.swing.JLabel createLabel(java.lang.String key)

Create a localized JLabel.

createCheckBox

protected javax.swing.JCheckBox createCheckBox(java.lang.String key)

Create a localized JCheckBox.

createRadioButton

protected javax.swing.JRadioButton createRadioButton(javax.swing.ButtonGroup bg,
                                                     java.lang.String key,
                                                     boolean selected)

Create a localized JRadioButton.

createTextField

protected javax.swing.JTextField createTextField()

Create a JTextField.

setModuleEnabled

public void setModuleEnabled(boolean v)

Description copied from interface: ArgoModule

Called to enable or disable a module programmatically.

Specified by:

setModuleEnabled in interface ArgoModule

Parameters:

v - true to enable module, false to disable

initializeModule

public boolean initializeModule()

Description copied from interface: ArgoModule

Method called when Argo is loading a module.

Specified by:

initializeModule in interface ArgoModule

Returns:

true if the module initialized properly.

inContext

public boolean inContext(java.lang.Object[] o)

Description copied from interface: Pluggable

A function which allows a plug-in to decide if it is available under a specific context. One example of a plugin with multiple criteria is the PluggableMenu. PluggableMenu requires the first context to be a JMenuItem which wants the PluggableMenu attached to as the context, so that it can determine that it would attach to a menu. The second context is an internal (non-localized) description of the menu such as "File" or "View" so that the plugin can further decide.

Specified by:

inContext in interface Pluggable

Parameters:

o - An identification of the context. The interpretation of criteria is specific to the plug-in type, but must be consistent across that type. The plug-in must want to be exposed to all contexts.

Returns:

True if the plug-in wants to make itself available for this context, otherwise false.

isModuleEnabled

public boolean isModuleEnabled()

Description copied from interface: ArgoModule

Allows determination if a module is enabled or disabled

Specified by:

isModuleEnabled in interface ArgoModule

Returns:

true if the module is enabled, otherwise false

getModulePopUpActions

public java.util.Vector getModulePopUpActions(java.util.Vector v,
                                              java.lang.Object o)

Description copied from interface: ArgoModule

Calls all modules to let them add to a popup menu.

Specified by:

getModulePopUpActions in interface ArgoModule

Parameters:

v - Vector of actions

o - which the actions are valid for

shutdownModule

public boolean shutdownModule()

Description copied from interface: ArgoModule

Method called when Argo is unloading a module.

Specified by:

shutdownModule in interface ArgoModule

Returns:

true if the module terminated properly.

getSettingsTabPanel

public SettingsTabPanel getSettingsTabPanel()

Description copied from interface: PluggableSettingsTab

Returns the settings tab panel for the plugin. This is found under the edit button.

Specified by:

getSettingsTabPanel in interface PluggableSettingsTab

Returns:

the setting tab panel.

getTabPanel

public javax.swing.JPanel getTabPanel()

Description copied from interface: SettingsTabPanel

Returns the JPanel which implements the tab.

Specified by:

getTabPanel in interface SettingsTabPanel

getTabResourceBundleKey

public java.lang.String getTabResourceBundleKey()

Description copied from interface: SettingsTabPanel

Returns the name of the resource bundle to use.

Specified by:

getTabResourceBundleKey in interface SettingsTabPanel