Overview

Package

Class

Use

Tree

Serialized

Deprecated

Index

Help

SWT LPEX
v3.0.0

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.ibm.lpex.alef
Class LpexViewPreferenceNode

java.lang.Object
  org.eclipse.jface.preference.PreferenceNode
      com.ibm.lpex.alef.LpexViewPreferenceNode

All Implemented Interfaces:

org.eclipse.jface.preference.IPreferenceNode

public class LpexViewPreferenceNode

extends org.eclipse.jface.preference.PreferenceNode

PreferenceNode for the view-scoped preference pages. You may extend this class in order to create custom preference page nodes. Extenders of this class must implement getLabelText().

See Also:

LpexAbstractTextEditor.createViewPreferencePage(com.ibm.lpex.core.LpexView, int), LpexSourceViewer.createViewPreferencePage(com.ibm.lpex.core.LpexView, int)

Field Summary

static int	VIEW_BASE_PREFERENCE_NODE Node type for the LPEX built-in base preference page (ViewBasePreferencePage).
static int	VIEW_PARSER_PREFERENCE_NODE Node type for the LPEX built-in parser preference page (ViewParserPreferencePage).
static int	VIEW_SEQUENCE_NUMBERS_PREFERENCE_NODE Node type for the LPEX built-in sequence-numbers preference page (SequenceNumbersPreferencePage).
static int	VIEW_SOURCE_ENCODING_PREFERENCE_NODE Node type for the LPEX built-in source-encoding preference page (SourceEncodingPreferencePage).

Constructor Summary

LpexViewPreferenceNode(LpexSourceViewer lpexSourceViewer)
Constructor for a custom view-scoped preference page node.

Method Summary

void	createPage() Creates and sets the preference page for this view-scoped node.
String	getLabelText() Returns the name of this preference node.
int	getNodeType() Retrieves the type of this preference node.

Methods inherited from class org.eclipse.jface.preference.PreferenceNode

add, disposeResources, findSubNode, getId, getImageDescriptor, getLabelImage, getPage, getSubNodes, remove, remove, setPage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VIEW_BASE_PREFERENCE_NODE

public static final int VIEW_BASE_PREFERENCE_NODE

Node type for the LPEX built-in base preference page (ViewBasePreferencePage).

See Also:

Constant Field Values

VIEW_PARSER_PREFERENCE_NODE

public static final int VIEW_PARSER_PREFERENCE_NODE

Node type for the LPEX built-in parser preference page (ViewParserPreferencePage).

See Also:

Constant Field Values

VIEW_SEQUENCE_NUMBERS_PREFERENCE_NODE

public static final int VIEW_SEQUENCE_NUMBERS_PREFERENCE_NODE

Node type for the LPEX built-in sequence-numbers preference page (SequenceNumbersPreferencePage).

See Also:

Constant Field Values

VIEW_SOURCE_ENCODING_PREFERENCE_NODE

public static final int VIEW_SOURCE_ENCODING_PREFERENCE_NODE

Node type for the LPEX built-in source-encoding preference page (SourceEncodingPreferencePage).

See Also:

Constant Field Values

Constructor Detail

LpexViewPreferenceNode

public LpexViewPreferenceNode(LpexSourceViewer lpexSourceViewer)

Constructor for a custom view-scoped preference page node. A node type is assigned to this prefence node, retrievable through getNodeType().

Parameters:

lpexSourceViewer - the source viewer instance

Method Detail

getNodeType

public int getNodeType()

Retrieves the type of this preference node.

getLabelText

public String getLabelText()

Returns the name of this preference node. The org.eclipse.jface.preference.PreferenceNode constructor used does not set a label. This will prevent the "Preferences" dialog from displaying this node (as there will be no text for this tree item's name): therefore, we must override getTextLabel() in order to return the desired name for this node.

createPage

public final void createPage()

Creates and sets the preference page for this view-scoped node. The primary view of the document in the source viewer is used.

Eclipse preference pages are created lazily when the user selects a node. getPage() != null is used to track what pages have been visited. When the "Preferences" dialog is dismissed, the node resources are disposed (disposeResources() is called); this method will be called when the user selects this node in a new "Preferences" dialog.

The custom preference page for this node must be created by extending LpexAbstractTextEditor.createViewPreferencePage(com.ibm.lpex.core.LpexView, int) or LpexSourceViewer.createViewPreferencePage(com.ibm.lpex.core.LpexView, int).