Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.eclipse.jface.preference
Interface IPreferenceNode  view IPreferenceNode download IPreferenceNode.java

All Known Implementing Classes:
PreferenceNode

public interface IPreferenceNode

Interface to a node in a preference dialog. A preference node maintains a label and image used to display the node in a preference dialog (usually in the form of a tree), as well as the preference page this node stands for. The node may use lazy creation for its page Note that all preference nodes must be dispose their resources. The node must dispose the page managed by this node, and any SWT resources allocated by this node (Images, Fonts, etc). However the node itself may be reused.


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()
          Release the page managed by this node, and any SWT resources held onto by this node (Images, Fonts, etc).
 IPreferenceNode findSubNode(java.lang.String id)
          Returns the subnode of this contribution node with the given node id.
 java.lang.String getId()
          Returns the id of this contribution node.
 org.eclipse.swt.graphics.Image getLabelImage()
          Returns the image used to present this node in a preference dialog.
 java.lang.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(java.lang.String id)
          Removes the subnode of this preference node with the given node id.
 

Method Detail

add

public void add(IPreferenceNode node)
Adds the given preference node as a subnode of this preference node.


createPage

public void createPage()
Creates the preference page for this node.


disposeResources

public void disposeResources()
Release the page managed by this node, and any SWT resources held onto by this node (Images, Fonts, etc). Note that nodes are reused so this is not a call to dispose the node itself.


findSubNode

public IPreferenceNode findSubNode(java.lang.String id)
Returns the subnode of this contribution node with the given node id.


getId

public java.lang.String getId()
Returns the id of this contribution node. This id identifies a contribution node relative to its parent.


getLabelImage

public org.eclipse.swt.graphics.Image getLabelImage()
Returns the image used to present this node in a preference dialog.


getLabelText

public java.lang.String getLabelText()
Returns the text label used to present this node in a preference dialog.


getPage

public IPreferencePage getPage()
Returns the preference page for this node.


getSubNodes

public IPreferenceNode[] getSubNodes()
Returns an iterator over the subnodes (immediate children) of this contribution node.


remove

public IPreferenceNode remove(java.lang.String id)
Removes the subnode of this preference node with the given node id.


remove

public boolean remove(IPreferenceNode node)
Removes the given preference node from the list of subnodes (immediate children) of this node.