com.lf.commons.dialog.options

Interface OptionsUnit

All Known Implementing Classes:

CategoryUnit, DialogUnit, DockingUnit, DownloadUnit, DragAndDropUnit, EditorWindowUnit, FilesUnit, FileSystemWindowUnit, FileTypeUnit, GUIUnit, SupportUnit, SuppressedDialogUnit, VFSWindowUnit

public interface OptionsUnit

Interface for configuring and displaying specialized items of the options dialog (tree nodes).

Subclasses should also implement the ConfigurableUnit interface in order to store the configured values persistently.

Since:

1.6

Version:

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

Author:

Axel Schwolow

Method Summary

Methods

Modifier and Type	Method and Description
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).
java.awt.Component	getComponent() Provides the GUI component to be displayed.
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.
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.
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	unitRemoved(OptionsDialog parent, java.lang.String id) Informs the unit that it was removed from the tabbed window.

Method Detail

getText

java.lang.String getText()

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

Returns:

The item text

Since:

1.6

getBigIcon

javax.swing.ImageIcon getBigIcon()

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

Returns:

The item icon

Since:

1.6

getSmallIcon

javax.swing.ImageIcon getSmallIcon()

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

Returns:

The item icon

Since:

1.6

getTitle

java.lang.String getTitle()

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

Returns:

The item title

Since:

1.6

getComponent

java.awt.Component getComponent()

Provides the GUI component to be displayed.

Returns:

The GUI component, null indicates folder functionality

Since:

1.6

find

int find(java.lang.String pattern)

Searches this unit for certain patterns specified by the user.

Does simple searching for the given pattern (no regex) to make it simple for the user to specify the pattern. The search is case insensitive and searches for whole words only. If the pattern is matched then the matching components are highlighted in some way to let the user find the matches easily.

Parameters:

pattern - The search pattern

Returns:

Match count, 0 means does not match

Since:

1.6

resetSearch

void resetSearch(java.lang.String pattern)

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

Parameters:

pattern - The search pattern

Since:

1.6

isModified

boolean isModified()

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

Returns:

Have the options been altered?

Since:

1.6

isInputValid

boolean isInputValid()

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

Returns:

Options OK?

Since:

1.6

unitAdded

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

Informs the unit that it was added to the dialog.

Parameters:

parent - The dialog

id - The unique ID

Since:

1.6

unitRemoved

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

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

Parameters:

parent - The dialog

id - The unique ID

Since:

1.6

unitBecomesShown

void unitBecomesShown()

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

Units may wait until this method is called and then initialize its GUI components.

Since:

1.6

unitBecomesHidden

void unitBecomesHidden()

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

Since:

1.6

unitIsShowing

void unitIsShowing()

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

Since:

1.6

unitIsHiding

void unitIsHiding()

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

Since:

1.6