|
RSE Release 3.0 |
|||||||||
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.SystemFilterAbstractFilterAction
public abstract class SystemFilterAbstractFilterAction
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.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 |
---|
protected SystemFilterDialogInputs dlgInputs
Constructor Detail |
---|
public SystemFilterAbstractFilterAction(Shell parent, String title)
public SystemFilterAbstractFilterAction(Shell parent, String title, String tooltip)
Method Detail |
---|
protected void init()
public void setHelpContextId(String id)
Same as #setHelp(String)
#getHelpContextId()
public void setDialogTitle(String title)
public String getDialogTitle()
public void setDialogPrompt(String prompt)
public String getDialogPrompt()
public void setDialogFilterNamePrompt(String prompt, String tip)
public String getDialogFilterFilterNamePrompt()
public String getDialogFilterNameTip()
public void setDialogPreSelectInput(Object selectData)
public Object getDialogPreSelectInput()
public boolean checkObjectType(Object selectedObject)
checkObjectType
in class SystemBaseAction
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 SystemFilterDialogInterface createFilterDialog(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.0 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |