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.preferences
Class UserCommandsPreferencePage

java.lang.Object
  org.eclipse.jface.dialogs.DialogPage
      org.eclipse.jface.preference.PreferencePage
          com.ibm.lpex.alef.preferences.TablePreferencePage
              com.ibm.lpex.alef.preferences.UserCommandsPreferencePage

All Implemented Interfaces:

org.eclipse.jface.dialogs.IDialogPage, org.eclipse.jface.dialogs.IMessageProvider, org.eclipse.jface.preference.IPreferencePage, org.eclipse.ui.IWorkbenchPreferencePage

public final class UserCommandsPreferencePage

extends com.ibm.lpex.alef.preferences.TablePreferencePage

Preference page for user commands. It lets the user add and remove user-defined editor commands.

Field Summary

Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider

ERROR, INFORMATION, NONE, WARNING

Constructor Summary

UserCommandsPreferencePage()

Method Summary

protected void	contributeButtons(org.eclipse.swt.widgets.Composite buttonBar) Contributes a "Reset" button.
protected org.eclipse.swt.widgets.Control	createContents(org.eclipse.swt.widgets.Composite parent)
protected String[]	getHelpIds() Return the context-help ids for the table and two text fields.
protected Vector	getItems() Retrieve the current vector of LpexTableItems in the table.
protected String[]	getValueNames() Return the names for the text-field labels.
protected String[]	getValueTableNames() Return the names for the table columns.
protected int[]	getValueWeights() Return the column weights for the two columns in the table.
void	init(org.eclipse.ui.IWorkbench workbench) Initializes this preference page for the given workbench.
protected Vector	initialize() Return a new vector of LpexTableItems with the initial (current) settings (the preference page is being initialized).
protected Vector	initializeDefaults() Return a new vector of LpexTableItems with the install settings ("Restore Defaults" button was pressed).
protected void	performDefaults() "Restore Defaults" button pressed.
boolean	performOk() "OK" / "Apply" button pressed.
protected void	performReset() "Reset" button pressed.
protected void	selectItem(String value1) Select an item in the table, and ensure it shows.
protected void	tableSelectionModified(String newValue1, String newValue2) Notification for subclasses that the table selection was modified.
protected org.eclipse.swt.widgets.Text	value1Info()
protected void	value1Modified() Value1 is being edited in the text field.
protected org.eclipse.swt.widgets.Text	value1TextField()

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

applyDialogFont, computeSize, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, okToLeave, performApply, performCancel, performHelp, setContainer, setErrorMessage, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButton

Methods inherited from class org.eclipse.jface.dialogs.DialogPage

convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, setButtonLayoutData, setControl, setDescription, setImageDescriptor, setMessage, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jface.preference.IPreferencePage

computeSize, isValid, okToLeave, performCancel, setContainer, setSize

Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage

createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible

Constructor Detail

UserCommandsPreferencePage

public UserCommandsPreferencePage()

Method Detail

createContents

protected org.eclipse.swt.widgets.Control createContents(org.eclipse.swt.widgets.Composite parent)

See Also:

PreferencePage.createContents(Composite)

getValueTableNames

protected String[] getValueTableNames()

Return the names for the table columns.

getValueNames

protected String[] getValueNames()

Return the names for the text-field labels.

getHelpIds

protected String[] getHelpIds()

Return the context-help ids for the table and two text fields.

getValueWeights

protected int[] getValueWeights()

Return the column weights for the two columns in the table.

initialize

protected Vector initialize()

Return a new vector of LpexTableItems with the initial (current) settings (the preference page is being initialized).

initializeDefaults

protected Vector initializeDefaults()

Return a new vector of LpexTableItems with the install settings ("Restore Defaults" button was pressed).

performOk

public boolean performOk()

"OK" / "Apply" button pressed. Commit any new updated values.

init

public void init(org.eclipse.ui.IWorkbench workbench)

Initializes this preference page for the given workbench. This method, defined by IWorkbenchPreferencePage, is called automatically when the preference page defined in plugin.xml is being created and initialized.

The TablePreferencePage implementation of this method does nothing.

Specified by:

init in interface org.eclipse.ui.IWorkbenchPreferencePage

value1TextField

protected org.eclipse.swt.widgets.Text value1TextField()

value1Info

protected org.eclipse.swt.widgets.Text value1Info()

contributeButtons

protected void contributeButtons(org.eclipse.swt.widgets.Composite buttonBar)

Contributes a "Reset" button. Method performReset() is called when this button is selected.

Parameters:

buttonBar - the preference-page button bar

See Also:

PreferencePage.contributeButtons(org.eclipse.swt.widgets.Composite), TablePreferencePage.performReset()

performDefaults

protected void performDefaults()

"Restore Defaults" button pressed. Set the table to the install settings.

performReset

protected void performReset()

"Reset" button pressed. Restore the initial preference page settings.

getItems

protected Vector getItems()

Retrieve the current vector of LpexTableItems in the table.

tableSelectionModified

protected void tableSelectionModified(String newValue1,
                                      String newValue2)

Notification for subclasses that the table selection was modified. The change was either the result of a user mouse click, or effected by us while tracking the value1 text field being edited.

value1Modified

protected void value1Modified()

Value1 is being edited in the text field. Look for and try to select the current value1 in the table.

selectItem

protected void selectItem(String value1)

Select an item in the table, and ensure it shows. If not in the table, clear any existing selection.