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.actions
Class SystemFilterAbstractFilterAction

java.lang.Object
  extended by 

org.eclipse.core.commands.common.EventManager
      extended by 

org.eclipse.jface.action.AbstractAction
          extended by 

org.eclipse.jface.action.Action
              extended by 

org.eclipse.rse.ui.actions.SystemBaseAction
                  extended by 

org.eclipse.rse.ui.actions.SystemBaseDialogAction
                      extended by 
org.eclipse.rse.ui.filters.actions.SystemFilterAbstractFilterAction
All Implemented Interfaces:
IAction, ISelectionChangedListener, ISystemAction, ISystemDialogAction
Direct Known Subclasses:
SystemFilterAbstractFilterWizardAction

public abstract class SystemFilterAbstractFilterAction
extends SystemBaseDialogAction

Base class capturing the attributes and operations common to dialog actions that work on system filters.


Field Summary
protected   SystemFilterDialogInputs dlgInputs
           
 
Fields inherited from class org.eclipse.rse.ui.actions. SystemBaseDialogAction
cancelled, dlgHelpId, needsProgressMonitor, needsProgressMonitorSet, processAll, value
 
Fields inherited from class org.eclipse.rse.ui.actions. SystemBaseAction
allowOnMultipleSelection, arrowCursor, helpId, selectionSensitive, shell, sSelection, traceSelections, traceTarget, viewer, waitCursor
 
Fields inherited from interface org.eclipse.jface.action. IAction
AS_CHECK_BOX, AS_DROP_DOWN_MENU, AS_PUSH_BUTTON, AS_RADIO_BUTTON, AS_UNSPECIFIED, CHECKED, DESCRIPTION, ENABLED, HANDLED, IMAGE, RESULT, TEXT, TOOL_TIP_TEXT
 
Constructor Summary
SystemFilterAbstractFilterAction ( Shell parent, String title)
          Constructor when given the translated action label
SystemFilterAbstractFilterAction ( Shell parent, String title, String tooltip)
          Constructor when given the translated action label and tooltip
 
Method Summary
 boolean checkObjectType ( Object selectedObject)
          Called by SystemBaseAction when selection is set.
protected   Dialog createDialog ( Shell parent)
          Overrides parent method to allow creating of a dialog meeting our interface, so we can pass instance of ourselves to it for callbacks to get our data.
abstract   SystemFilterDialogInterface createFilterDialog ( Shell parent)
          Where you create the dialog meeting our interface.
abstract  void doOKprocessing ( Object dlgValue)
          Method called when ok pressed on dialog and after getDialogValue has set the value attribute appropriately.
  String getDialogFilterFilterNamePrompt ()
          Get the dialog's filter name prompt text.
  String getDialogFilterNameTip ()
          Get the dialog's filter name tooltip text.
  Object getDialogPreSelectInput ()
          Get the dialog's pre-select information.
  String getDialogPrompt ()
          Get the dialog prompt.
  String getDialogTitle ()
          Get the dialog title.
protected abstract   Object getDialogValue ( Dialog dlg)
          If you decide to use the supplied run method as is, then you must override this method to retrieve the data from the dialog.
protected  void init ()
          Common initialization code
 void run ()
          Extends run in parent class to call doOKprocessing if the result of calling getDialogValue() resulted in a non-null value.
 void setDialogFilterNamePrompt ( String prompt, String tip)
          Set the dialog's filter name prompt text and tooltip Either call this or override getDialogFilterNamePrompt/Tip()
 void setDialogPreSelectInput ( Object selectData)
          Set the dialog's pre-select information.
 void setDialogPrompt ( String prompt)
          Set the dialog prompt text.
 void setDialogTitle ( String title)
          Set the dialog title.
 void setHelpContextId ( String id)
          Set the help context Id (infoPop) for this action.
 
Methods inherited from class org.eclipse.rse.ui.actions. SystemBaseDialogAction
getDialogHelpContextId, getNeedsProgressMonitor, getProcessAllSelections, getValue, setDialogHelp, setNeedsProgressMonitor, setProcessAllSelections, setValue, wasCancelled, wasNeedsProgressMonitorSet
 
Methods inherited from class org.eclipse.rse.ui.actions. SystemBaseAction
allowOnMultipleSelection, getContextMenuGroup, getCurrentTreeView, getFirstSelection, getHelpContextId, getNextSelection, getRemoteAdapter, getSelection, getSelectionProvider, getShell, getShell, getSystemConnection, getViewAdapter, getViewer, isDummy, isEnabled, isSelectionSensitive, issueTraceMessage, selectionChanged, setAvailableOffline, setBusyCursor, setContextMenuGroup, setDisplayCursor, setDisplayCursor, setHelp, setHost, setInputs, setSelection, setSelectionProvider, setSelectionSensitive, setShell, setTracing, setTracing, setViewer, updateSelection
 
Methods inherited from class org.eclipse.jface.action. Action
convertAccelerator, convertAccelerator, findKeyCode, findKeyString, findModifier, findModifierString, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isHandled, notifyResult, removeAcceleratorText, removeMnemonics, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from class org.eclipse.jface.action. AbstractAction
addPropertyChangeListener, firePropertyChange, firePropertyChange, removePropertyChangeListener
 
Methods inherited from class org.eclipse.core.commands.common. EventManager
addListenerObject, clearListeners, getListeners, isListenerAttached, removeListenerObject
 
Methods inherited from class java.lang. Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.rse.ui.actions. ISystemAction
allowOnMultipleSelection, getContextMenuGroup, getHelpContextId, getSelection, getShell, getViewer, isDummy, isSelectionSensitive, setContextMenuGroup, setHelp, setInputs, setSelection, setSelectionSensitive, setShell, setViewer
 
Methods inherited from interface org.eclipse.jface.action. IAction
addPropertyChangeListener, getAccelerator, getActionDefinitionId, getDescription, getDisabledImageDescriptor, getHelpListener, getHoverImageDescriptor, getId, getImageDescriptor, getMenuCreator, getStyle, getText, getToolTipText, isChecked, isEnabled, isHandled, removePropertyChangeListener, runWithEvent, setAccelerator, setActionDefinitionId, setChecked, setDescription, setDisabledImageDescriptor, setEnabled, setHelpListener, setHoverImageDescriptor, setId, setImageDescriptor, setMenuCreator, setText, setToolTipText
 
Methods inherited from interface org.eclipse.jface.viewers. ISelectionChangedListener
selectionChanged
 

Field Detail

dlgInputs

protected 
SystemFilterDialogInputs dlgInputs
Constructor Detail

SystemFilterAbstractFilterAction

public SystemFilterAbstractFilterAction(
Shell parent,
                                        
String title)
Constructor when given the translated action label


SystemFilterAbstractFilterAction

public SystemFilterAbstractFilterAction(
Shell parent,
                                        
String title,
                                        
String tooltip)
Constructor when given the translated action label and tooltip

Method Detail

init

protected void init()
Common initialization code


setHelpContextId

public void setHelpContextId(
String id)
Set the help context Id (infoPop) for this action. This must be fully qualified by plugin ID.

Same as #setHelp(String)

See Also:
#getHelpContextId()

setDialogTitle

public void setDialogTitle(
String title)
Set the dialog title. Either call this or override getDialogTitle()


getDialogTitle

public 
String getDialogTitle()
Get the dialog title. By default, uses what was given in setDialogTitle, or an english default if nothing set.


setDialogPrompt

public void setDialogPrompt(
String prompt)
Set the dialog prompt text. Either call this or override getDialogPrompt()


getDialogPrompt

public 
String getDialogPrompt()
Get the dialog prompt. By default, uses what was given in setDialogPrompt


setDialogFilterNamePrompt

public void setDialogFilterNamePrompt(
String prompt,
                                      
String tip)
Set the dialog's filter name prompt text and tooltip Either call this or override getDialogFilterNamePrompt/Tip()


getDialogFilterFilterNamePrompt

public 
String getDialogFilterFilterNamePrompt()
Get the dialog's filter name prompt text. By default, uses what was given in setDialogFilterNamePrompt.


getDialogFilterNameTip

public 
String getDialogFilterNameTip()
Get the dialog's filter name tooltip text. By default, uses what was given in setDialogFilterNamePrompt.


setDialogPreSelectInput

public void setDialogPreSelectInput(
Object selectData)
Set the dialog's pre-select information. Either call this or override getDialogPreSelectInput()


getDialogPreSelectInput

public 
Object getDialogPreSelectInput()
Get the dialog's pre-select information. By default, uses what was given in setDialogPreSelectInput.


checkObjectType

public boolean checkObjectType(
Object selectedObject)
Called by SystemBaseAction when selection is set. Our opportunity to verify we are allowed for this selected type.

Overrides:
checkObjectType in class SystemBaseAction

run

public void run()
Extends run in parent class to call doOKprocessing if the result of calling getDialogValue() resulted in a non-null value.

Specified by:
run in interface IAction
Overrides:
run in class SystemBaseDialogAction
See Also:
Action.run()

createDialog

protected 
Dialog createDialog(
Shell parent)
Overrides parent method to allow creating of a dialog meeting our interface, so we can pass instance of ourselves to it for callbacks to get our data.

If your dialog does not implement our interface, override this method!

Specified by:
createDialog in class SystemBaseDialogAction
See Also:
SystemBaseDialogAction.run()

createFilterDialog

public abstract 
SystemFilterDialogInterface createFilterDialog(
Shell parent)
Where you create the dialog meeting our interface. If you override createDialog, then override this to return null


getDialogValue

protected abstract 
Object getDialogValue(
Dialog dlg)
If you decide to use the supplied run method as is, then you must override this method to retrieve the data from the dialog. For InputDialog dialogs, this is simply a matter of return dlg.getValue();

This is called by the run method after the dialog returns. Callers of this object can subsequently retrieve it by calling getValue.

Specified by:
getDialogValue in class SystemBaseDialogAction
Parameters:
dlg - The dialog object, after it has returned from open.

doOKprocessing

public abstract void doOKprocessing(
Object dlgValue)
Method called when ok pressed on dialog and after getDialogValue has set the value attribute appropriately.

Only called if user pressed OK on dialog.

Parameters:
dlgValue - The output of getDialogValue().

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