org.freehep.jas.services
Interface PreferencesTopic

All Known Implementing Classes:
FileOpener, FTreePlugin, PluginManager, SimpleWebBrowser, XMLIOPlugin

public interface PreferencesTopic

An interface to be implemented by anything that wants to appear in the preferences dialog.

Author:
tonyj

Method Summary
 boolean apply(JComponent panel)
          Called when the user pushes the apply button in the preferences dialog.
 JComponent component()
          Get the component to display in the preferences dialog
 String[] path()
          Specifies where in the preferences tree this item should appear.
 

Method Detail

path

String[] path()
Specifies where in the preferences tree this item should appear.

Returns:
The path under which this topic should be displayed in the preferences dialog.

component

JComponent component()
Get the component to display in the preferences dialog

Returns:
The component to be used.

apply

boolean apply(JComponent panel)
Called when the user pushes the apply button in the preferences dialog. This is also called if the user changes to another preferences topic, or if the user hits OK to dismiss the preferences dialog.

Parameters:
panel - The component currently being displayed
Returns:
true if success, false if an error occured (invalid input)
See Also:
component()


Copyright © 2013. All Rights Reserved.