|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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.filters.actions.SystemFilterAbstractFilterPoolAction
public abstract class SystemFilterAbstractFilterPoolAction
Base class capturing the attributes and operations common to dialog actions that work on system filter pools.
Field Summary | |
---|---|
protected SystemFilterPoolDialogInputs |
dlgInputs
|
protected String |
mgrNamePreselect
|
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 | |
---|---|
SystemFilterAbstractFilterPoolAction(Shell parent,
ImageDescriptor image,
String label,
String tooltip)
Constructor when given the resource bundle and key for the action label |
|
SystemFilterAbstractFilterPoolAction(Shell parent,
String title)
Constructor when given the translated action label |
|
SystemFilterAbstractFilterPoolAction(Shell parent,
String title,
String tooltip)
Constructor when given the translated action label |
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 SystemFilterPoolDialogInterface |
createFilterPoolDialog(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 |
getDialogFilterPoolManagerNamePrompt()
Get the dialog's filter pool manager name prompt text. |
String |
getDialogFilterPoolManagerNameTip()
Get the dialog's filter pool manager name tooltip text. |
String |
getDialogFilterPoolNamePrompt()
Get the dialog's filter pool name prompt text. |
String |
getDialogFilterPoolNameTip()
Get the dialog's filter pool 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. |
int |
getFilterPoolManagerNameSelectionIndex()
Returns the zero-based index of the manager name to preselect. |
ISystemFilterPoolManagerProvider |
getFilterPoolManagerProvider()
Get the input filter pool manager provider from which to get the list of filter pool managers. |
ISystemFilterPoolManager[] |
getFilterPoolManagers()
Returns the filter pool managers from which to show filter pools for selection. |
protected boolean |
getFilterPoolPreSelection(ISystemFilterPool pool)
Decide per pool if it should be selected or not. |
ISystemFilterPoolReferenceManager |
getFilterPoolReferenceManager()
Returns the filter pool reference manager which contains the list of selected filter pools that this dialog is showing and allowing the user to change. |
protected ISystemFilterPoolReferenceManagerProvider |
getReferenceManagerProviderSelection()
Return the current selection if it implements SystemFilterPoolReferenceManagerProvider |
protected void |
init()
Common initialization code |
protected void |
preSelect(SystemSimpleContentElement inputElement)
Walk elements deciding pre-selection |
void |
run()
Extends run in parent class to call doOKprocessing if the result of calling getDialogValue() resulted in a non-null value. |
void |
setDialogFilterPoolManagerNamePrompt(String prompt,
String tip)
Set the dialog's filter pool manager name prompt text and tooltip Either call this or override getDialogFilterPoolManagerNamePrompt/Tip() |
void |
setDialogFilterPoolNamePrompt(String prompt,
String tip)
Set the dialog's filter pool name prompt text and tooltip Either call this or override getDialogFilterPoolNamePrompt/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 |
setFilterPoolManagerNamePreSelection(String name)
Set the name of the filter pool manager to pre-select |
void |
setFilterPoolManagerNameSelectionIndex(int index)
Set the zero-based index of the manager name to preselect. |
void |
setFilterPoolManagerProvider(ISystemFilterPoolManagerProvider provider)
Set the input filter pool manager provider from which to get the list of filter pool managers. |
void |
setFilterPoolManagers(ISystemFilterPoolManager[] managers)
Set the input filter pool managers from which to allow selections of filter pools. |
void |
setFilterPoolReferenceManager(ISystemFilterPoolReferenceManager refManager)
Set the input filter pool reference manager which is holding the references this dialog is allowing the user to select. |
void |
setHelpContextId(String id)
Set the help context Id (infoPop) for this action. |
void |
setSelection(ISelection selection)
This is called by the UI calling the action, if that UI is not a selection provider. |
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.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, 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 |
---|
protected SystemFilterPoolDialogInputs dlgInputs
protected String mgrNamePreselect
Constructor Detail |
---|
public SystemFilterAbstractFilterPoolAction(Shell parent, String title)
public SystemFilterAbstractFilterPoolAction(Shell parent, String title, String tooltip)
public SystemFilterAbstractFilterPoolAction(Shell parent, ImageDescriptor image, String label, String tooltip)
Method Detail |
---|
protected void init()
public void setHelpContextId(String id)
Same as #setHelp(String)
#getHelpContextId()
public void setSelection(ISelection selection)
setSelection
in interface ISystemAction
setSelection
in class SystemBaseAction
SystemBaseAction.selectionChanged(SelectionChangedEvent event)
public void setFilterPoolManagerProvider(ISystemFilterPoolManagerProvider provider)
public ISystemFilterPoolManagerProvider getFilterPoolManagerProvider()
public void setFilterPoolManagers(ISystemFilterPoolManager[] managers)
public ISystemFilterPoolManager[] getFilterPoolManagers()
By default, tries the following in this order:
protected ISystemFilterPoolReferenceManagerProvider getReferenceManagerProviderSelection()
public void setFilterPoolManagerNameSelectionIndex(int index)
public int getFilterPoolManagerNameSelectionIndex()
public void setFilterPoolManagerNamePreSelection(String name)
public void setFilterPoolReferenceManager(ISystemFilterPoolReferenceManager refManager)
If you call this, then this action has everything it needs to know to be fully self-contained. It will totally handle updating the reference manager with the user's selections and deselections.
public ISystemFilterPoolReferenceManager getFilterPoolReferenceManager()
If not set, then the subclass needs to override doOKprocessing.
public void setDialogTitle(String title)
public String getDialogTitle()
public void setDialogPrompt(String prompt)
public String getDialogPrompt()
public void setDialogFilterPoolNamePrompt(String prompt, String tip)
public String getDialogFilterPoolNamePrompt()
public String getDialogFilterPoolNameTip()
public void setDialogFilterPoolManagerNamePrompt(String prompt, String tip)
public String getDialogFilterPoolManagerNamePrompt()
public String getDialogFilterPoolManagerNameTip()
public void setDialogPreSelectInput(Object selectData)
public Object getDialogPreSelectInput()
public boolean checkObjectType(Object selectedObject)
checkObjectType
in class SystemBaseAction
protected void preSelect(SystemSimpleContentElement inputElement)
protected boolean getFilterPoolPreSelection(ISystemFilterPool pool)
public void run()
run
in interface IAction
run
in class SystemBaseDialogAction
Action.run()
protected Dialog createDialog(Shell parent)
If your dialog does not implement our interface, override this method!
createDialog
in class SystemBaseDialogAction
SystemBaseDialogAction.run()
public abstract SystemFilterPoolDialogInterface createFilterPoolDialog(Shell parent)
protected abstract Object getDialogValue(Dialog dlg)
This is called by the run method after the dialog returns. Callers of this object can subsequently retrieve it by calling getValue.
getDialogValue
in class SystemBaseDialogAction
dlg
- The dialog object, after it has returned from open.public abstract void doOKprocessing(Object dlgValue)
Only called if user pressed OK on dialog.
dlgValue
- The output of getDialogValue().
|
RSE Release 3.4 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |