RSE
Release 3.3

org.eclipse.rse.ui.propertypages
Class SystemFilterStringPropertyPage

java.lang.Object
  extended by org.eclipse.jface.dialogs.DialogPage
      extended by org.eclipse.jface.preference.PreferencePage
          extended by org.eclipse.ui.dialogs.PropertyPage
              extended by org.eclipse.rse.ui.propertypages.SystemBasePropertyPage
                  extended by org.eclipse.rse.ui.propertypages.SystemFilterStringPropertyPage
All Implemented Interfaces:
IDialogPage, IMessageProvider, IPreferencePage, ISystemFilterStringEditPaneListener, ISystemMessageLine, ISystemMessageLineTarget, IWorkbenchPropertyPage

public class SystemFilterStringPropertyPage
extends SystemBasePropertyPage
implements ISystemFilterStringEditPaneListener

The property page for filter string properties. This is an output-only page. The plugin.xml file registers this for objects of class org.eclipse.rse.internal.filters.SystemFilterString


Field Summary
protected  Composite composite_prompts
           
protected  SystemMessage dupeFilterStringMessage
           
protected  boolean editable
           
protected  SystemFilterStringEditPane editPane
           
protected  SystemMessage errorMessage
           
protected  ISystemValidator filterStringValidator
           
protected  boolean initDone
           
protected  Label labelFilter
           
protected  Label labelFilterPool
           
protected  Label labelProfile
           
protected  Label labelType
           
protected  ResourceBundle rb
           
 
Fields inherited from class org.eclipse.rse.ui.propertypages.SystemBasePropertyPage
buttonsComposite, contentArea, msgLine, msgLineSet
 
Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
SystemFilterStringPropertyPage()
          Constructor
 
Method Summary
 void backupChangedState()
          Callback method.
protected  Control createContentArea(Composite parent)
          Create the page's GUI contents.
protected  void doInitializeFields()
          Initialize values of input fields based on input
 void filterStringChanged(SystemMessage message)
          Callback method.
protected  ISystemFilterString getFilterString()
          Get the input filter string object
 boolean performOk()
          Called by parent when user presses OK
 void restoreChangedState()
          Callback method.
 void setDuplicateFilterStringErrorMessage(SystemMessage msg)
          Configuration method
Set the error message to use when the user is editing or creating a filter string, and the Apply processing detects a duplicate filter string in the list.
 void setEditable(boolean editable)
          Set if the edit pane is not to be editable
 void setFilterStringEditPane(SystemFilterStringEditPane editPane)
          Configuration method
Specify an edit pane that prompts the user for the contents of a filter string.
 void setFilterStringValidator(ISystemValidator v)
          Configuration method
Call this to specify a validator for the filter string.
 void setSystemFilterPoolManagerProvider(ISystemFilterPoolManagerProvider provider)
          Configuration method
Set the contextual system filter pool manager provider.
 void setSystemFilterPoolReferenceManagerProvider(ISystemFilterPoolReferenceManagerProvider provider)
          Configuration method
Set the contextual system filter pool reference manager provider.
protected  boolean verifyPageContents()
          From parent: do full page validation
 
Methods inherited from class org.eclipse.rse.ui.propertypages.SystemBasePropertyPage
addFillerLine, addSeparatorLine, clearErrorMessage, clearMessage, configureMessageLine, contributeButtons, createContents, createLabeledCombo, createLabeledLabel, createLabeledText, createLabeledVerbiage, getMessageLine, getSystemErrorMessage, grabExcessSpace, okToLeave, setBusyCursor, setErrorMessage, setErrorMessage, setErrorMessage, setHelp, setMessage, setMessage, setMessageLine, wantAutomaticValidManagement, wantDefaultAndApplyButton, wantMnemonics
 
Methods inherited from class org.eclipse.ui.dialogs.PropertyPage
getElement, setElement
 
Methods inherited from class org.eclipse.jface.preference.PreferencePage
applyData, applyDialogFont, computeSize, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, performApply, performCancel, performDefaults, performHelp, setContainer, 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, setVisible
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.rse.ui.messages.ISystemMessageLine
getErrorMessage, getMessage
 
Methods inherited from interface org.eclipse.jface.preference.IPreferencePage
computeSize, isValid, 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
 

Field Detail

labelType

protected Label labelType

labelFilter

protected Label labelFilter

labelFilterPool

protected Label labelFilterPool

labelProfile

protected Label labelProfile

editPane

protected SystemFilterStringEditPane editPane

filterStringValidator

protected ISystemValidator filterStringValidator

dupeFilterStringMessage

protected SystemMessage dupeFilterStringMessage

editable

protected boolean editable

composite_prompts

protected Composite composite_prompts

errorMessage

protected SystemMessage errorMessage

rb

protected ResourceBundle rb

initDone

protected boolean initDone
Constructor Detail

SystemFilterStringPropertyPage

public SystemFilterStringPropertyPage()
Constructor

Method Detail

setFilterStringEditPane

public void setFilterStringEditPane(SystemFilterStringEditPane editPane)
Configuration method
Specify an edit pane that prompts the user for the contents of a filter string.


setSystemFilterPoolReferenceManagerProvider

public void setSystemFilterPoolReferenceManagerProvider(ISystemFilterPoolReferenceManagerProvider provider)
Configuration method
Set the contextual system filter pool reference manager provider. Will be non-null if the current selection is a reference to a filter pool or filter, or a reference manager provider itself (eg subsystem)

This is passed into the filter and filter string wizards and dialogs in case it is needed for context.


setSystemFilterPoolManagerProvider

public void setSystemFilterPoolManagerProvider(ISystemFilterPoolManagerProvider provider)
Configuration method
Set the contextual system filter pool manager provider. Will be non-null if the current selection is a filter pool or filter or reference to either, or a manager provider itself (eg subsystemconfiguration)

This is passed into the filter and filter string wizards and dialogs in case it is needed for context.


setFilterStringValidator

public void setFilterStringValidator(ISystemValidator v)
Configuration method
Call this to specify a validator for the filter string. It will be called per keystroke. A default validator is supplied otherwise: ValidatorFilterString.

Your validator should extend ValidatorFilterString to inherited the uniqueness error checking.

Alternatively, if all you want is a unique error message for the case when duplicates are found, call setDuplicateFilterStringErrorMessage, and it will be used in the default validator.


setDuplicateFilterStringErrorMessage

public void setDuplicateFilterStringErrorMessage(SystemMessage msg)
Configuration method
Set the error message to use when the user is editing or creating a filter string, and the Apply processing detects a duplicate filter string in the list.


setEditable

public void setEditable(boolean editable)
Set if the edit pane is not to be editable


createContentArea

protected Control createContentArea(Composite parent)
Create the page's GUI contents.

Specified by:
createContentArea in class SystemBasePropertyPage
See Also:
PreferencePage.createContents(Composite)

verifyPageContents

protected boolean verifyPageContents()
From parent: do full page validation

Specified by:
verifyPageContents in class SystemBasePropertyPage
Returns:
true if there are no errors, false if any errors were found.

getFilterString

protected ISystemFilterString getFilterString()
Get the input filter string object


doInitializeFields

protected void doInitializeFields()
Initialize values of input fields based on input


performOk

public boolean performOk()
Called by parent when user presses OK

Specified by:
performOk in interface IPreferencePage
Overrides:
performOk in class SystemBasePropertyPage
Returns:
true if all is well, false if there is an error.

filterStringChanged

public void filterStringChanged(SystemMessage message)
Description copied from interface: ISystemFilterStringEditPaneListener
Callback method. The user has changed the filter string. It may or may not be valid. If not, the given message is non-null. If it is, and you want it, call getSystemFilterString() in the edit pane.

Specified by:
filterStringChanged in interface ISystemFilterStringEditPaneListener

backupChangedState

public void backupChangedState()
Description copied from interface: ISystemFilterStringEditPaneListener
Callback method. We are about to do a verify,the side effect of which is to change the current state of the dialog, which we don't want. This tells the dialog to back up that state so it can be restored.

Specified by:
backupChangedState in interface ISystemFilterStringEditPaneListener

restoreChangedState

public void restoreChangedState()
Description copied from interface: ISystemFilterStringEditPaneListener
Callback method. After backup and change events this is called to restore state

Specified by:
restoreChangedState in interface ISystemFilterStringEditPaneListener

RSE
Release 3.3

Copyright (c) IBM Corporation and others 2000, 2011. All Rights Reserved.