Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

RSE
Release 3.0

org.eclipse.rse.ui.propertypages
Class SystemChangeFilterPropertyPage

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.SystemChangeFilterPropertyPage
All Implemented Interfaces:
IDialogPage, IMessageProvider, IPreferencePage, ISystemChangeFilterPaneEditPaneSupplier, ISystemPageCompleteListener, ISystemMessageLine, ISystemMessageLineTarget, IWorkbenchPropertyPage

public class SystemChangeFilterPropertyPage
extends SystemBasePropertyPage
implements ISystemPageCompleteListener, ISystemChangeFilterPaneEditPaneSupplier

This is the property page for changing filters. This page used to be the Change dialog. The plugin.xml file registers this for objects of class org.eclipse.rse.internal.filters.SystemFilter or org.eclipse.rse.filters.SystemFilterReference.

If you have your own change filter dialog (versus configuring ours) you must configure this pane yourself by overriding SubSystemConfigurationAdapter.customizeChangeFilterPropertyPage(ISubSystemConfiguration, SystemChangeFilterPropertyPage, ISystemFilter, Shell) and configuring the pane as described in that method's javadoc.


Field Summary
protected   SystemChangeFilterPane changeFilterPane
           
protected   SystemFilterStringEditPane editPane
           
protected   String errorMessage
           
protected  boolean initDone
           
 
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
SystemChangeFilterPropertyPage ()
          Constructor for SystemFilterPropertyPage
 
Method Summary
protected  void contributeButtons ( Composite parent)
          Intercept of parent so we can reset the default button
protected   Control createContentArea ( Composite parent)
          Create the page's GUI contents.
protected   ISystemFilter getFilter ()
          Get the input filter object
  SystemFilterStringEditPane getFilterStringEditPane ( Shell shell)
          Return our edit pane.
 boolean performCancel ()
          Called by parent when user presses Cancel
 boolean performOk ()
          Called by parent when user presses OK
 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 setListLabel ( String label, String tip)
          Configuration method
Set the label shown in group box around the filter string list, and the tooltip text for the list box.
 void setNamePromptLabel ( String label, String tip)
          Configuration method
Set the name prompt label and tooltip text.
 void setNewListItemText ( String label)
          Set the string to show as the first item in the list.
 void setPageComplete (boolean complete)
          The comleteness of the page has changed.
 void setParentPoolPromptLabel ( String label, String tip)
          Configuration method
Set the Parent Filter Pool prompt label and tooltip text.
 void setSupportsMultipleStrings (boolean multi)
          Set if the user is to be allowed to create multiple filter strings or not.
 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.
 void setWantTestButton (boolean wantTestButton)
          Configuration method
Specify if you want to include a test button or not.
protected  boolean verifyPageContents ()
          Parent-required method.
 
Methods inherited from class org.eclipse.rse.ui.propertypages. SystemBasePropertyPage
addFillerLine, addSeparatorLine, clearErrorMessage, clearMessage, configureMessageLine, 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, 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, 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

errorMessage

protected 
String errorMessage

initDone

protected boolean initDone

changeFilterPane

protected 
SystemChangeFilterPane changeFilterPane

editPane

protected 
SystemFilterStringEditPane editPane
Constructor Detail

SystemChangeFilterPropertyPage

public SystemChangeFilterPropertyPage()
Constructor for SystemFilterPropertyPage

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.


setParentPoolPromptLabel

public void setParentPoolPromptLabel(
String label,
                                     
String tip)
Configuration method
Set the Parent Filter Pool prompt label and tooltip text.


setNamePromptLabel

public void setNamePromptLabel(
String label,
                               
String tip)
Configuration method
Set the name prompt label and tooltip text.


setListLabel

public void setListLabel(
String label,
                         
String tip)
Configuration method
Set the label shown in group box around the filter string list, and the tooltip text for the list box.


setNewListItemText

public void setNewListItemText(
String label)
Set the string to show as the first item in the list. The default is "New filter string"


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.


setWantTestButton

public void setWantTestButton(boolean wantTestButton)
Configuration method
Specify if you want to include a test button or not. Appears with "Apply" and "Reset"


setEditable

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


setSupportsMultipleStrings

public void setSupportsMultipleStrings(boolean multi)
Set if the user is to be allowed to create multiple filter strings or not. Default is true


createContentArea

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

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

contributeButtons

protected void contributeButtons(
Composite parent)
Intercept of parent so we can reset the default button

Overrides:
contributeButtons in class SystemBasePropertyPage

verifyPageContents

protected boolean verifyPageContents()
Parent-required method. Do full page validation. Return true if ok, false if there is an error.

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

getFilter

protected 
ISystemFilter getFilter()
Get the input filter object


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.

performCancel

public boolean performCancel()
Called by parent when user presses Cancel

Specified by:
performCancel in interface IPreferencePage
Overrides:
performCancel in class PreferencePage

setPageComplete

public void setPageComplete(boolean complete)
The comleteness of the page has changed. This is a callback from SystemChangeFilterPane.

Specified by:
setPageComplete in interface ISystemPageCompleteListener
Parameters:
complete - complete indicator as set by the caller
See Also:
SystemBaseForm.addPageCompleteListener(ISystemPageCompleteListener)

getFilterStringEditPane

public 
SystemFilterStringEditPane getFilterStringEditPane(
Shell shell)
Return our edit pane. Overriding this is an alternative to calling setEditPane. Method is declared in ISystemChangeFilterPaneEditPaneSupplier.

Specified by:
getFilterStringEditPane in interface ISystemChangeFilterPaneEditPaneSupplier

RSE
Release 3.0

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

 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire