public interface Preference
Preference
class allows plugin developers to add their own preferences
to the Spark client.Modifier and Type | Method and Description |
---|---|
void |
commit()
Called whenever the preference should be saved.
|
java.lang.Object |
getData()
Returns the data model representing this preference.
|
java.lang.String |
getErrorMessage()
The error message to display if #isDataDisplayed returns false.
|
javax.swing.JComponent |
getGUI()
Return the UI to display whenever this preference is selected in the preference dialog.
|
javax.swing.Icon |
getIcon()
Return the icon to use inside the Preferences list.
|
java.lang.String |
getListName()
Return the title to use inside the Preferences list.
|
java.lang.String |
getNamespace()
Returns the associated namespace of this preference.
|
java.lang.String |
getTitle()
Return the title to use in the preference window.
|
java.lang.String |
getTooltip()
Return the tooltip to use for this preference.
|
boolean |
isDataValid()
Return true if the data supplied is valid, otherwise return false.
|
void |
load()
Called whenever the preference is invoked from the Preference list.
|
void |
shutdown()
Called when Spark is closing.
|
java.lang.String getTitle()
javax.swing.Icon getIcon()
java.lang.String getTooltip()
java.lang.String getListName()
java.lang.String getNamespace()
javax.swing.JComponent getGUI()
void load()
void commit()
boolean isDataValid()
java.lang.String getErrorMessage()
java.lang.Object getData()
void shutdown()