com.leafdigital.prefsui.api
Interface PreferencesUI

All Superinterfaces:
Singleton

public interface PreferencesUI
extends Singleton

Singleton that allows you to add/remove pages from the preferences dialog and the startup wizard dialog.


Method Summary
 void registerPage(Plugin owner, Page p)
          Adds a page to the prefs dialog.
 void registerWizardPage(Plugin owner, int order, Page p)
          Registers a page for the basic wizard interface.
 void unregisterPage(Plugin owner, Page p)
          Removes a page from the prefs dialog.
 void unregisterWizardPage(Page p)
          Removes a page from the prefs dialog.
 

Method Detail

registerPage

void registerPage(Plugin owner,
                  Page p)
Adds a page to the prefs dialog. Providing the plugin owner means you don't need to call unregisterPage when the plugin's closed.

Parameters:
p - Page to add
owner - Plugin that owns page

unregisterPage

void unregisterPage(Plugin owner,
                    Page p)
Removes a page from the prefs dialog.

Parameters:
p - Page to remove
owner - Plugin that owns page
Throws:
BugException - if the page doesn't exist

registerWizardPage

void registerWizardPage(Plugin owner,
                        int order,
                        Page p)
Registers a page for the basic wizard interface. Providing the plugin owner means you don't need to call unregisterWizardPage when the plugin's closed.

Parameters:
owner - Plugin that owns page
order - Integer indicating order of page. Lower numbers are first. A gap should be left to allow insertion of other pages.
p - Page to add

unregisterWizardPage

void unregisterWizardPage(Page p)
Removes a page from the prefs dialog.

Parameters:
p - Page to remove


Copyright © 2011 Samuel Marshall. All rights reserved.