com.lf.commons.dialog.options

Class SupportUnit

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.lf.commons.dialog.options.SupportUnit

All Implemented Interfaces:

OptionsUnit, ConfigurableUnit, java.awt.event.ActionListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, java.util.EventListener, javax.accessibility.Accessible

public class SupportUnit
extends javax.swing.JPanel
implements ConfigurableUnit, OptionsUnit, java.awt.event.ActionListener

Configurable panel to configure the categories used for the status reports.

Sending status reports may be limited to Premium Support users.

Since:

1.6

Version:

$Revision: 1.2 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected OrderedHashtable<java.lang.String,java.lang.Object[]>	allowedCategoryIDs Container for the allowed type ids set by the application (key: identifier, value: type+desc).
static java.net.URL	ICON_SMALL Default unit icon.
protected boolean	initialized Components have been setup already?
protected java.util.Vector<java.awt.Component>	matches Remembers the components matching a search pattern for reset.
protected javax.swing.tree.DefaultTreeModel	model Model of the category list.
protected java.lang.Class[]	tableClasses Column name.
protected java.lang.String[]	tableColumns Column name.
protected java.lang.Object[][]	tableData List of categories currently displayed by the list.

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.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
SupportUnit() Constructor of this form.

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(java.awt.event.ActionEvent event) Called whenever the one of the components was activated.
void	addCategory(java.lang.String id, java.lang.String type, java.lang.String desc) Adds an allowed category to be managed by the chooser.
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
protected void	finalize() Cares for proper cleanup after releasing the object.
int	find(java.lang.String pattern) Searches this unit for certain patterns specified by the user.
javax.swing.ImageIcon	getBigIcon() Provides the graphical icon of a certain size (normally 32x32 pixels).
int	getCategoryCount() Provides the number of categories currently managed by the panel.
static boolean	getCategoryEnabled(java.lang.String unitid, Configuration config, java.lang.String catid) Convenience for applications to get a certain category flag.
javax.swing.JTable	getCategoryTable() Provides the categories table.
java.awt.Component	getComponent() Provides the GUI component to be displayed.
protected int	getRowIndex(java.lang.String id) Determines the index/row of the given target category.
javax.swing.ImageIcon	getSmallIcon() Provides the graphical icon of a certain size (normally 16x16 pixels).
java.lang.String	getText() Provides the text of the item to be displayed in the list of the OptionsDialog.
java.lang.String	getTitle() Provides the title of the item to be displayed on top of the OptionsDialog.
protected void	init() Initializes the GUI components.
boolean	isInputValid() Provides the info if the options of this unit are OK to be used.
boolean	isModified() Provides the info if the options of this unit have been changed.
void	resetSearch(java.lang.String pattern) Resets this unit so that the components do not highlight any search results.
static boolean	setCategoryEnabled(java.lang.String unitid, Configuration config, java.lang.String catid, boolean enable) Convenience for applications to set a certain category flag.
static void	storeDefaultValues(java.lang.String id, Configuration config, OrderedHashtable<java.lang.String,java.lang.Boolean> defaults) Convenience method to populate the configuration with default values.
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.
void	unitAdded(OptionsDialog parent, java.lang.String id) Informs the unit that it was added to the dialog.
void	unitBecomesHidden() Informs the unit that it will vanish from the screen (deselected).
void	unitBecomesShown() Informs the unit that it becomes visible on the screen (selected).
void	unitIsHiding() Informs the unit that it was made invisible by the manager (deselected).
void	unitIsShowing() Informs the unit that it was made visible by the manager (selected).
void	unitRegistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitRemoved(OptionsDialog parent, java.lang.String id) Informs the unit that it was removed from the tabbed window.
void	unitUnregistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, 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, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, 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, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

ICON_SMALL

public static java.net.URL ICON_SMALL

Default unit icon.

tableColumns

protected java.lang.String[] tableColumns

Column name.

tableClasses

protected java.lang.Class[] tableClasses

Column name.

tableData

protected java.lang.Object[][] tableData

List of categories currently displayed by the list.

model

protected javax.swing.tree.DefaultTreeModel model

Model of the category list.

initialized

protected boolean initialized

Components have been setup already?

matches

protected java.util.Vector<java.awt.Component> matches

Remembers the components matching a search pattern for reset.

allowedCategoryIDs

protected OrderedHashtable<java.lang.String,java.lang.Object[]> allowedCategoryIDs

Container for the allowed type ids set by the application (key: identifier, value: type+desc).

Constructor Detail

SupportUnit

public SupportUnit()

Constructor of this form.

Since:

1.6

Method Detail

init

protected void init()

Initializes the GUI components.

Since:

1.6

finalize

protected void finalize()
                 throws java.lang.Throwable

Cares for proper cleanup after releasing the object.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

Since:

1.6

addCategory

public void addCategory(java.lang.String id,
               java.lang.String type,
               java.lang.String desc)

Adds an allowed category to be managed by the chooser.

The allowed category must be installed BEFORE the unit is configured from the model. Only allowed categorys are restored in order to prevent from errors due to user manipulated configuration files. The name is locale specific and not restored.

Parameters:

id - The unique identifier

type - The text to be displayed (required)

desc - The description to be displayed (required)

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeDefaultValues

public static void storeDefaultValues(java.lang.String id,
                      Configuration config,
                      OrderedHashtable<java.lang.String,java.lang.Boolean> defaults)

Convenience method to populate the configuration with default values.

The global Drag & Drop flag must be set using setDragAndDropEnabled().

Parameters:

id - The unique identifier for the instance

config - The configuration

defaults - Key: type identifier, value: index 0=pattern (String), index 1=type (int)

Throws:

java.lang.NullPointerException - If a parameter is null

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

unitRegistered

public void unitRegistered(ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

getCategoryEnabled

public static boolean getCategoryEnabled(java.lang.String unitid,
                         Configuration config,
                         java.lang.String catid)

Convenience for applications to get a certain category flag.

Parameters:

unitid - The unique identifier for the ConfigurableUnit

config - The configuration

catid - The unique identifier for the category

Returns:

Category enabled (failsafe is false)?

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

setCategoryEnabled

public static boolean setCategoryEnabled(java.lang.String unitid,
                         Configuration config,
                         java.lang.String catid,
                         boolean enable)

Convenience for applications to set a certain category flag.

Parameters:

unitid - The unique identifier for the ConfigurableUnit

config - The configuration

catid - The unique identifier for the category

enable - Category enabled?

Returns:

Successful?

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

getRowIndex

protected int getRowIndex(java.lang.String id)

Determines the index/row of the given target category.

Parameters:

id - The category identifier

Returns:

The row index, -1 if not available

Since:

1.6

getCategoryCount

public int getCategoryCount()

Provides the number of categories currently managed by the panel.

Returns:

The number of categories

Since:

1.6

getText

public java.lang.String getText()

Provides the text of the item to be displayed in the list of the OptionsDialog.

Specified by:

getText in interface OptionsUnit

Returns:

The item text

Since:

1.6

getBigIcon

public javax.swing.ImageIcon getBigIcon()

Provides the graphical icon of a certain size (normally 32x32 pixels).

Specified by:

getBigIcon in interface OptionsUnit

Returns:

The item icon

Since:

1.6

getSmallIcon

public javax.swing.ImageIcon getSmallIcon()

Provides the graphical icon of a certain size (normally 16x16 pixels).

Specified by:

getSmallIcon in interface OptionsUnit

Returns:

The item icon

Since:

1.6

getTitle

public java.lang.String getTitle()

Provides the title of the item to be displayed on top of the OptionsDialog.

Specified by:

getTitle in interface OptionsUnit

Returns:

The item title

Since:

1.6

getComponent

public java.awt.Component getComponent()

Provides the GUI component to be displayed.

Specified by:

getComponent in interface OptionsUnit

Returns:

The GUI component, null indicates folder functionality

Since:

1.6

find

public int find(java.lang.String pattern)

Searches this unit for certain patterns specified by the user.

Specified by:

find in interface OptionsUnit

Parameters:

pattern - The search pattern

Returns:

Match count, 0 means does not match

Since:

1.6

resetSearch

public void resetSearch(java.lang.String pattern)

Resets this unit so that the components do not highlight any search results.

Specified by:

resetSearch in interface OptionsUnit

Parameters:

pattern - The search pattern

Since:

1.6

isModified

public boolean isModified()

Provides the info if the options of this unit have been changed.

Specified by:

isModified in interface OptionsUnit

Returns:

Has the options been altered?

Since:

1.6

isInputValid

public boolean isInputValid()

Provides the info if the options of this unit are OK to be used.

Specified by:

isInputValid in interface OptionsUnit

Returns:

Options OK?

Since:

1.6

unitAdded

public void unitAdded(OptionsDialog parent,
             java.lang.String id)

Informs the unit that it was added to the dialog.

Specified by:

unitAdded in interface OptionsUnit

Parameters:

parent - The dialog

id - The unique ID

Since:

1.6

unitRemoved

public void unitRemoved(OptionsDialog parent,
               java.lang.String id)

Informs the unit that it was removed from the tabbed window.

Specified by:

unitRemoved in interface OptionsUnit

Parameters:

parent - The dialog

id - The unique ID

Since:

1.6

unitBecomesShown

public void unitBecomesShown()

Informs the unit that it becomes visible on the screen (selected).

Specified by:

unitBecomesShown in interface OptionsUnit

Since:

1.6

unitBecomesHidden

public void unitBecomesHidden()

Informs the unit that it will vanish from the screen (deselected).

Specified by:

unitBecomesHidden in interface OptionsUnit

Since:

1.6

unitIsShowing

public void unitIsShowing()

Informs the unit that it was made visible by the manager (selected).

Specified by:

unitIsShowing in interface OptionsUnit

Since:

1.6

unitIsHiding

public void unitIsHiding()

Informs the unit that it was made invisible by the manager (deselected).

Specified by:

unitIsHiding in interface OptionsUnit

Since:

1.6

getCategoryTable

public javax.swing.JTable getCategoryTable()

Provides the categories table.

Returns:

Categories table

Since:

1.6

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent event)

Called whenever the one of the components was activated.

Specified by:

actionPerformed in interface java.awt.event.ActionListener

Parameters:

event - The event object

Since:

1.6