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.filters.dialogs
Class SystemNewFilterWizardMainPage

java.lang.Object
  extended by 

org.eclipse.jface.dialogs.DialogPage
      extended by 

org.eclipse.jface.wizard.WizardPage
          extended by 

org.eclipse.rse.ui.wizards.AbstractSystemWizardPage
              extended by 
org.eclipse.rse.ui.filters.dialogs.SystemNewFilterWizardMainPage
All Implemented Interfaces:
IDialogPage, IMessageProvider, IWizardPage, ISystemFilterStringEditPaneListener, ISystemMessageLine, ISystemWizardPage

public class SystemNewFilterWizardMainPage
extends AbstractSystemWizardPage
implements ISystemFilterStringEditPaneListener

Main page of the abstract "New Filter" wizard. This page's content is supplyable in the form of an "edit pane" which essentially is reponsible for the content area of the wizard, and which implements necessary minimal methods for this wizard to interact with it.

As per the design goals of the filter wizard, this page effectively only prompts to create a single new filter string. Thus, the edit pane needed is in fact the "new filter string" edit pane.


Field Summary
protected   String[] defaultFilterStrings
           
protected   SystemFilterStringEditPane editPane
           
protected  boolean firstVisit
           
protected   String type
           
 
Fields inherited from interface org.eclipse.jface.dialogs. IMessageProvider
ERROR, INFORMATION, NONE, WARNING
 
Constructor Summary
SystemNewFilterWizardMainPage ( SystemNewFilterWizard wizard, ISystemNewFilterWizardConfigurator data)
          Constructor.
SystemNewFilterWizardMainPage ( SystemNewFilterWizard wizard, SystemFilterStringEditPane editPane, ISystemNewFilterWizardConfigurator data)
          Constructor when unique edit pane supplied Uses the wizard page title as set in the overall wizard.
 
Method Summary
 void backupChangedState ()
          Callback method.
  Control createContents ( Composite parent)
          CreateContents is the one method that must be overridden from the parent class.
 void filterStringChanged ( SystemMessage message)
          Callback method.
protected   SystemFilterStringEditPane getEditPane ( Shell shell)
          Overrride this if you want to supply your own edit pane for the filter string.
  Vector getFilterStrings ()
          Return the user-specified filter strings
protected   Control getInitialFocusControl ()
          Return the Control to be given initial focus.
  String getType ()
          Get the type of filter as set by setType(String)
 boolean performFinish ()
          Completes processing of the wizard.
 void restoreChangedState ()
          Callback method.
 void setDefaultFilterStrings ( String[] defaultFilterStrings)
          Supply the default set of filter strings this filter is to have.
 void setSystemFilterPoolReferenceManagerProvider ( ISystemFilterPoolReferenceManagerProvider provider)
          Set the contextual system filter pool reference manager provider.
 void setType ( String type)
          Set the type of filter we are creating.
 void setVisible (boolean visible)
          This is called when a page is given focus or loses focus
 
Methods inherited from class org.eclipse.rse.ui.wizards. AbstractSystemWizardPage
addFillerLine, addGrowableFillerLine, addSeparatorLine, applyMnemonics, clearErrorMessage, clearMessage, createControl, dispose, getHelpContextId, getInputObject, getMessageLine, getSystemErrorMessage, setErrorMessage, setErrorMessage, setErrorMessage, setFocus, setHelp, setInputObject, setMessage, setMessage, setMessage
 
Methods inherited from class org.eclipse.jface.wizard. WizardPage
canFlipToNextPage, getContainer, getDialogSettings, getImage, getName, getNextPage, getPreviousPage, getShell, getWizard, isCurrentPage, isPageComplete, setDescription, setImageDescriptor, setPageComplete, setPreviousPage, setTitle, setWizard, toString
 
Methods inherited from class org.eclipse.jface.dialogs. DialogPage
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getMessage, getMessageType, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, performHelp, setButtonLayoutData, setControl
 
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.dialogs. IDialogPage
getControl, getDescription, getErrorMessage, getMessage, getTitle, performHelp
 

Field Detail

editPane

protected 
SystemFilterStringEditPane editPane

type

protected 
String type

defaultFilterStrings

protected 
String[] defaultFilterStrings

firstVisit

protected boolean firstVisit
Constructor Detail

SystemNewFilterWizardMainPage

public SystemNewFilterWizardMainPage(
SystemNewFilterWizard wizard,
                                     
ISystemNewFilterWizardConfigurator data)
Constructor. Uses the wizard page title as set in the overall wizard. Uses a default wizard page description. Change later via setDescription if desired.

Parameters:
wizard - - the parent new filter wizard
data - - configurable mri data

SystemNewFilterWizardMainPage

public SystemNewFilterWizardMainPage(
SystemNewFilterWizard wizard,
                                     
SystemFilterStringEditPane editPane,
                                     
ISystemNewFilterWizardConfigurator data)
Constructor when unique edit pane supplied Uses the wizard page title as set in the overall wizard. Uses a default wizard page description. Change later via setDescription if desired.

Parameters:
wizard - - the parent new filter wizard
editPane - - the edit pane that prompts the user for a single filter string
data - - configurable mri data
Method Detail

setSystemFilterPoolReferenceManagerProvider

public void setSystemFilterPoolReferenceManagerProvider(
ISystemFilterPoolReferenceManagerProvider provider)
Set the contextual system filter pool reference manager provider. Ie, in the RSE this is the currently selected subsystem if this wizard was launched from a subsystem.

Will be non-null if the current selection is a reference to a filter pool or filter, or a reference manager provider.

This is not used by default but made available for subclasses.


getEditPane

protected 
SystemFilterStringEditPane getEditPane(
Shell shell)
Overrride this if you want to supply your own edit pane for the filter string.


createContents

public 
Control createContents(
Composite parent)
CreateContents is the one method that must be overridden from the parent class. In this method, we populate an SWT container with widgets and return the container to the caller (JFace). This is used as the contents of this page.

Specified by:
createContents in class AbstractSystemWizardPage
See Also:
SystemWidgetHelpers

performFinish

public boolean performFinish()
Completes processing of the wizard. If this method returns true, the wizard will close; otherwise, it will stay active. This method is an override from the parent Wizard class.

Specified by:
performFinish in interface ISystemWizardPage
Specified by:
performFinish in class AbstractSystemWizardPage
Returns:
whether the wizard finished successfully

getInitialFocusControl

protected 
Control getInitialFocusControl()
Return the Control to be given initial focus. Override from parent. Return control to be given initial focus.

Specified by:
getInitialFocusControl in class AbstractSystemWizardPage

getFilterStrings

public 
Vector getFilterStrings()
Return the user-specified filter strings


getType

public 
String getType()
Get the type of filter as set by setType(String)


setType

public void setType(
String type)
Set the type of filter we are creating. Results in a call to setType on the new filter. Types are not used by the base filter framework but are a way for tools to create typed filters and have unique actions per filter type.


setDefaultFilterStrings

public void setDefaultFilterStrings(
String[] defaultFilterStrings)
Supply the default set of filter strings this filter is to have.


filterStringChanged

public void filterStringChanged(
SystemMessage message)
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()
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()
Callback method. After backup and change events this is called to restore state

Specified by:
restoreChangedState in interface ISystemFilterStringEditPaneListener

setVisible

public void setVisible(boolean visible)
This is called when a page is given focus or loses focus

Specified by:
setVisible in interface IDialogPage
Overrides:
setVisible in class AbstractSystemWizardPage

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