com.autodesk.ui
Interface Preferences

public interface Preferences

This interface is used by classes that are used to build panels for displaying preference items. Classes implementing this interface should not use any of the com.autodesk.ui undoable components. Items in a preference panel should not be undoable using their undo mechanism. Doing so would be very confusing to the user as they see nothing happening when selecting undo after the Preferences dialog box has been dismissed.

Method Summary

javax.swing.Icon	getIcon() Get an icon that identifies this preferences panel.
java.lang.String	getLabel() Get the name that will be shown on the tab for this panel.
javax.swing.JPanel	getPanel() Get a JPanel to display the preference settings.
java.lang.String	getTooltip() Get a localized tooltip that describes the preferences panel.

Method Detail

getPanel

javax.swing.JPanel getPanel()

Get a JPanel to display the preference settings. Classes implementing the Preferences interface need to implement this method which is called when the Preferences panel is being built. A new panel will be created each time the user selects to display the preferences.

Returns:

a JPanel that displays the contents of the preference panel.

getLabel

java.lang.String getLabel()

Get the name that will be shown on the tab for this panel.

Returns:

the localized label for the preference panel.

getIcon

javax.swing.Icon getIcon()

Get an icon that identifies this preferences panel.

Returns:

an Icon

getTooltip

java.lang.String getTooltip()

Get a localized tooltip that describes the preferences panel.

Returns:

the localized tooltip text.