|
Eclipse Platform Release 3.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
java.lang.Objectorg.eclipse.jface.preference.PreferenceNode
A concrete implementation of a node in a preference dialog tree. This class also supports lazy creation of the node's preference page.
| Constructor Summary | |
|---|---|
PreferenceNode(String id)
Creates a new preference node with the given id. |
|
PreferenceNode(String id,
IPreferencePage preferencePage)
Creates a preference node with the given id and preference page. |
|
PreferenceNode(String id,
String label,
ImageDescriptor image,
String className)
Creates a preference node with the given id, label, and image, and lazily-loaded preference page. |
|
| Method Summary | |
|---|---|
void |
add(IPreferenceNode node)
Adds the given preference node as a subnode of this preference node. |
void |
createPage()
Creates the preference page for this node. |
void |
disposeResources()
(non-Javadoc) Method declared on IPreferenceNode. |
IPreferenceNode |
findSubNode(String id)
Returns the subnode of this contribution node with the given node id. |
String |
getId()
Returns the id of this contribution node. |
protected ImageDescriptor |
getImageDescriptor()
Returns the image descriptor for this node. |
Image |
getLabelImage()
Returns the image used to present this node in a preference dialog. |
String |
getLabelText()
Returns the text label used to present this node in a preference dialog. |
IPreferencePage |
getPage()
Returns the preference page for this node. |
IPreferenceNode[] |
getSubNodes()
Returns an iterator over the subnodes (immediate children) of this contribution node. |
boolean |
remove(IPreferenceNode node)
Removes the given preference node from the list of subnodes (immediate children) of this node. |
IPreferenceNode |
remove(String id)
Removes the subnode of this preference node with the given node id. |
void |
setPage(IPreferencePage newPage)
Set the current page to be newPage. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public PreferenceNode(String id)
id - the node id
public PreferenceNode(String id,
String label,
ImageDescriptor image,
String className)
id - the node idlabel - the label used to display the node in the preference dialog's
treeimage - the image displayed left of the label in the preference
dialog's tree, or null if noneclassName - the class name of the preference page; this class must
implement IPreferencePage
public PreferenceNode(String id,
IPreferencePage preferencePage)
id - the node idpreferencePage - the preference page| Method Detail |
public void add(IPreferenceNode node)
IPreferenceNode
add in interface IPreferenceNodenode - the node to addpublic void createPage()
IPreferenceNode
createPage in interface IPreferenceNodepublic void disposeResources()
disposeResources in interface IPreferenceNodepublic IPreferenceNode findSubNode(String id)
IPreferenceNode
findSubNode in interface IPreferenceNodeid - the preference node id
null if nonepublic String getId()
IPreferenceNode
getId in interface IPreferenceNodeprotected ImageDescriptor getImageDescriptor()
public Image getLabelImage()
IPreferenceNode
getLabelImage in interface IPreferenceNodenull
if there is no image for this nodepublic String getLabelText()
IPreferenceNode
getLabelText in interface IPreferenceNodenull
if there is no label for this nodepublic IPreferencePage getPage()
IPreferenceNode
getPage in interface IPreferenceNodepublic IPreferenceNode[] getSubNodes()
IPreferenceNode
getSubNodes in interface IPreferenceNodepublic IPreferenceNode remove(String id)
IPreferenceNode
remove in interface IPreferenceNodeid - the subnode id
null if nonepublic boolean remove(IPreferenceNode node)
IPreferenceNode
remove in interface IPreferenceNodenode - the node to remove
true if the node was removed,
and false otherwisepublic void setPage(IPreferencePage newPage)
newPage -
|
Eclipse Platform Release 3.3 |
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||||
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2007. All rights reserved.