org.eclipse.rse.files.ui.actions
Class SystemNewFileFilterFromFolderAction

java.lang.Object
  org.eclipse.core.commands.common.EventManager
      org.eclipse.jface.action.AbstractAction
          org.eclipse.jface.action.Action
              org.eclipse.rse.ui.actions.SystemBaseAction
                  org.eclipse.rse.ui.actions.SystemBaseDialogAction
                      org.eclipse.rse.ui.actions.SystemBaseWizardAction
                          org.eclipse.rse.ui.filters.actions.SystemNewFilterAction
                              org.eclipse.rse.files.ui.actions.SystemNewFileFilterAction
                                  org.eclipse.rse.files.ui.actions.SystemNewFileFilterFromFolderAction

All Implemented Interfaces:

IAction, ISelectionChangedListener, ISystemAction, ISystemDialogAction, ISystemWizardAction

public class SystemNewFileFilterFromFolderAction

extends SystemNewFileFilterAction

Class for defining a new filter from a preselected folder

Field Summary

Fields inherited from class org.eclipse.rse.ui.filters.actions.SystemNewFilterAction

callbackConfigurator, callbackConfiguratorCalled, callbackData, defaultFilterStrings, editPane, filterPoolSelectionValidator, fromRSE, namePageHelp, nested, page1Description, parentPool, poolsToSelectFrom, poolWrapperInformation, showFilterStrings, showInfoPage, showNamePrompt, type, verbage

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

SystemNewFileFilterFromFolderAction(Shell parent)
Constructor for SystemNewFileFilterFromFolderAction

Method Summary

protected void	configureNewFilterWizard(SystemNewFilterWizard wizard) Parent intercept.
ISystemFilterPoolReferenceManagerProvider	getSystemFilterPoolReferenceManagerProvider() Output method.
void	run() This is the method called by the system when the user selects this action.
boolean	updateSelection(IStructuredSelection selection) Called when the selection changes in the systems view.

Methods inherited from class org.eclipse.rse.files.ui.actions.SystemNewFileFilterAction

setParentFilterPool

Methods inherited from class org.eclipse.rse.ui.filters.actions.SystemNewFilterAction

checkObjectType, configureNewFilter, createNewFilterWizard, createWizard, getFilterString, getFilterStrings, getNewFilter, getType, postProcessWizard, setAllowFilterPoolSelection, setAllowFilterPoolSelection, setCallBackConfigurator, setDefaultFilterStrings, setFilterPoolSelectionValidator, setFilterStringEditPane, setFromRSE, setHelpContextId, setNamePageHelp, setPage1Description, setShowFilterStrings, setShowInfoPage, setShowNamePrompt, setType, setVerbage

Methods inherited from class org.eclipse.rse.ui.actions.SystemBaseWizardAction

createDialog, getDialogValue, getWizardPageTitle, setMinimumPageSize, setWizardImage, setWizardPageTitle, setWizardTitle, wasCancelled

Methods inherited from class org.eclipse.rse.ui.actions.SystemBaseDialogAction

getDialogHelpContextId, getNeedsProgressMonitor, getProcessAllSelections, getValue, setDialogHelp, setNeedsProgressMonitor, setProcessAllSelections, setValue, wasNeedsProgressMonitorSet

Methods inherited from class org.eclipse.rse.ui.actions.SystemBaseAction

allowOnMultipleSelection, getAdapter, getContextMenuGroup, getCurrentTreeView, getFirstSelection, getHelpContextId, getNextSelection, getRemoteAdapter, getSelection, getSelectionProvider, getShell, getShell, getSystemConnection, getViewer, isDummy, isEnabled, isSelectionSensitive, issueTraceMessage, selectionChanged, setAvailableOffline, setBusyCursor, setContextMenuGroup, setDisplayCursor, setDisplayCursor, setHelp, setHost, setInputs, setSelection, setSelectionProvider, setSelectionSensitive, setShell, setTracing, setTracing, setViewer

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.ISystemDialogAction

getValue, setProcessAllSelections, setValue

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

Constructor Detail

SystemNewFileFilterFromFolderAction

public SystemNewFileFilterFromFolderAction(Shell parent)

Constructor for SystemNewFileFilterFromFolderAction

Parameters:

parent -

Method Detail

run

public void run()

Description copied from class: SystemBaseDialogAction

This is the method called by the system when the user selects this action. This is a default implementation which:

• calls abstract method createDialog() to get the dialog object. Child classes must implement this method.
• if the returned dialog implements ISystemPromptDialog, then it will call setInputObject passing getValue() as the paramter. If getValue returns null, then instead the currently selected objects are passed as the parameter. If setProcessAllSelections has been called then the current ISelection is passed, else the each object in the selection is passed, and the dialog is displayed once per selected object. Your dialog can then cast this input as necessary to initialize its input fields, say. Presumably it knows what to cast it to. Note: code that creates actions does not typically call setValue unless the action is used in a UI that has no concept of ISelection, such as a raw swt widget. ISelection is a JFace viewer concept.
• calls dlg.open(getShell()) on the dialog to display it.
• calls setValue(getDialogValue(dlg)) so callers can get the dialog output via a call to getValue() on this action object. Again, this is typically only used when launching actions from non-viewers, such as launching one dialog from another dialog. When launching from popup-menus of viewers, use selectionChanged instead. Either way, the object set or selected is passed on to the dialog, if not null, by way of a call to the dialog's setInputObject method.

If this action is to be enabled when multiple items are selected (the default) then the processing above is repeated once for every object selected. If your dialog actually processes all the selected items, then call setProcessAllSelections(true) to change the behaviour to only do all of this once. In this case setInputObject will be called with the entire IStructuredSelection object, and your dialog code can process each of the objects in it.

Please note that if NO ITEMS are selected, we will still call createDialog but not call setInput.

To use this default implementation you must implement the createDialog method. Note we will also call dlg.setBlockOnOpen(true) on the returned dialog to force it to be modal.

Specified by:

run in interface IAction

Overrides:

run in class SystemBaseDialogAction

updateSelection

public boolean updateSelection(IStructuredSelection selection)

Called when the selection changes in the systems view. This determines the input object for the command and whether to enable or disable the action.

Overrides:

updateSelection in class SystemBaseAction

Parameters:

selection - the current seleciton

Returns:

whether to enable or disable the action

getSystemFilterPoolReferenceManagerProvider

public ISystemFilterPoolReferenceManagerProvider getSystemFilterPoolReferenceManagerProvider()

Output method. Do not override.
Get the contextual system filter pool reference manager provider. Will return non-null if the current selection is a reference to a filter pool or filter, or a reference manager provider.

Overrides:

getSystemFilterPoolReferenceManagerProvider in class SystemNewFilterAction

configureNewFilterWizard

protected void configureNewFilterWizard(SystemNewFilterWizard wizard)

Parent intercept.

Overridable extension. For those cases when you don't want to create your own wizard subclass, but prefer to simply configure the default wizard.

Note, at the point this is called, all the base configuration, based on the setters for this action, have been called.

We do it here versus via setters as it defers some work until the user actually selects this action.

Overrides:

configureNewFilterWizard in class SystemNewFileFilterAction