|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.rse.ui.dialogs.SystemPromptDialog
org.eclipse.rse.ui.filters.dialogs.SystemChangeFilterDialog
public class SystemChangeFilterDialog
A dialog that allows the user to change a filter. It allows update of the filter strings.
We do not typically override this to produce our own change filter dialog ... rather we usually
call the configuration methods to affect it. At a minimum, we usually want to set the editpane
,
which is used to prompt for a new filter string or change an existing one. We usually share the
same edit pane with the SystemNewFilterWizard
wizard.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.eclipse.jface.window.Window |
---|
Window.IExceptionHandler |
Field Summary | |
---|---|
protected SystemChangeFilterPane |
changeFilterPane
|
protected SystemFilterStringEditPane |
editPane
|
Fields inherited from class org.eclipse.jface.dialogs.Dialog |
---|
blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS |
Fields inherited from class org.eclipse.jface.window.Window |
---|
CANCEL, OK |
Constructor Summary | |
---|---|
SystemChangeFilterDialog(Shell shell)
Constructor |
|
SystemChangeFilterDialog(Shell shell,
String title)
Constructor, when unique title desired |
Method Summary | |
---|---|
protected void |
createButtonsForButtonBar(Composite parent)
Intercept of parent so we can reset the default button |
protected Control |
createInner(Composite parent)
Populates the content area |
SystemMessage |
getDuplicateFilterStringErrorMessage()
Return results of setDuplicateFilterStringErrorMessage(SystemMessage) |
boolean |
getEditable()
Return whether the edit pane is editable, as set by setEditable(boolean) |
SystemFilterStringEditPane |
getFilterStringEditPane(Shell shell)
Return our edit pane. |
ISystemValidator |
getFilterStringValidator()
Return the result of setFilterStringValidator(ISystemValidator) . |
protected Control |
getInitialFocusControl()
Returns the control (the list view) to recieve initial focus control |
String |
getListLabel()
Return list label as set by setListLabel(String, String) |
String |
getListTip()
Return list tip as set by setListLabel(String, String) |
String |
getNamePromptLabel()
Return the name prompt label as set by setNamePromptLabel(String, String) |
String |
getNamePromptTip()
Return the name prompt tip as set by setNamePromptLabel(String, String) |
String |
getNewListItemText()
Return the text for the list item, as set by setNewListItemText(String) ,
or the default if not set. |
String |
getParentPoolPromptLabel()
Return the parent filter pool prompt label, as set by setParentPoolPromptLabel(String, String) |
String |
getParentPoolPromptTip()
Return the parent filter pool prompt tip, as set by setParentPoolPromptLabel(String, String) |
Shell |
getParentShell()
Returns parent shell, under which this window's shell is created. |
boolean |
getSupportsMultipleStrings()
Return whether the user is to be allowed to create multiple filter strings or not. |
boolean |
getWantTestButton()
Return whether a test button is wanted or not, as set by setWantTestButton(boolean) |
protected boolean |
processCancel()
Parent override. |
protected boolean |
processOK()
Parent override. |
void |
setDuplicateFilterStringErrorMessage(SystemMessage msg)
Configuration method Set the error message to use when the user is editing or creating a filter string, and the Apply processing detects a duplicate filter string in the list. |
void |
setEditable(boolean editable)
Set if the edit pane is not to be editable |
void |
setFilterStringEditPane(SystemFilterStringEditPane editPane)
Configuration method Specify an edit pane that prompts the user for the contents of a filter string. |
void |
setFilterStringValidator(ISystemValidator v)
Configuration method Call this to specify a validator for the filter string. |
protected void |
setHelp()
Overridable extension point for setting dialog help |
void |
setInputObject(Object inputObject)
Intercept of parent so we can set the input filter, and deduce whether strings are case sensitive and if duplicates are allowed. |
void |
setListLabel(String label,
String tip)
Configuration method Set the label shown in group box around the filter string list, and the tooltip text for the list box. |
void |
setNamePromptLabel(String label,
String tip)
Configuration method Set the name prompt label and tooltip text. |
void |
setNewListItemText(String label)
Set the string to show as the first item in the list. |
void |
setPageComplete(boolean complete)
The comleteness of the page has changed. |
void |
setParentPoolPromptLabel(String label,
String tip)
Configuration method Set the Parent Filter Pool prompt label and tooltip text. |
void |
setSupportsMultipleStrings(boolean multi)
Set if the user is to be allowed to create multiple filter strings or not. |
void |
setSystemFilterPoolManagerProvider(ISystemFilterPoolManagerProvider provider)
Configuration method Set the contextual system filter pool manager provider. |
void |
setSystemFilterPoolReferenceManagerProvider(ISystemFilterPoolReferenceManagerProvider provider)
Configuration method Set the contextual system filter pool reference manager provider. |
void |
setWantTestButton(boolean wantTestButton)
Configuration method Specify if you want to include a test button or not. |
Methods inherited from class org.eclipse.jface.window.Window |
---|
canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getLayout, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected SystemChangeFilterPane changeFilterPane
protected SystemFilterStringEditPane editPane
Constructor Detail |
---|
public SystemChangeFilterDialog(Shell shell)
public SystemChangeFilterDialog(Shell shell, String title)
Method Detail |
---|
protected void setHelp()
public void setFilterStringEditPane(SystemFilterStringEditPane editPane)
public void setSystemFilterPoolReferenceManagerProvider(ISystemFilterPoolReferenceManagerProvider provider)
This is passed into the filter and filter string wizards and dialogs in case it is needed for context.
public void setSystemFilterPoolManagerProvider(ISystemFilterPoolManagerProvider provider)
This is passed into the filter and filter string wizards and dialogs in case it is needed for context.
public void setParentPoolPromptLabel(String label, String tip)
public String getParentPoolPromptLabel()
setParentPoolPromptLabel(String, String)
public String getParentPoolPromptTip()
setParentPoolPromptLabel(String, String)
public void setNamePromptLabel(String label, String tip)
public String getNamePromptLabel()
setNamePromptLabel(String, String)
public String getNamePromptTip()
setNamePromptLabel(String, String)
public void setListLabel(String label, String tip)
public String getListLabel()
setListLabel(String, String)
public String getListTip()
setListLabel(String, String)
public void setNewListItemText(String label)
public String getNewListItemText()
setNewListItemText(String)
,
or the default if not set.
public void setFilterStringValidator(ISystemValidator v)
Your validator should extend ValidatorFilterString to inherited the uniqueness error checking.
Alternatively, if all you want is a unique error message for the case when duplicates are found, call setDuplicateFilterStringErrorMessage, and it will be used in the default validator.
public ISystemValidator getFilterStringValidator()
setFilterStringValidator(ISystemValidator)
.
public void setDuplicateFilterStringErrorMessage(SystemMessage msg)
public SystemMessage getDuplicateFilterStringErrorMessage()
setDuplicateFilterStringErrorMessage(SystemMessage)
public void setWantTestButton(boolean wantTestButton)
public boolean getWantTestButton()
setWantTestButton(boolean)
public void setEditable(boolean editable)
public boolean getEditable()
setEditable(boolean)
public void setSupportsMultipleStrings(boolean multi)
public boolean getSupportsMultipleStrings()
public void setInputObject(Object inputObject)
setInputObject
in interface ISystemPromptDialog
setInputObject
in class SystemPromptDialog
protected Control getInitialFocusControl()
getInitialFocusControl
in class SystemPromptDialog
protected Control createInner(Composite parent)
createInner
in class SystemPromptDialog
protected void createButtonsForButtonBar(Composite parent)
createButtonsForButtonBar
in class SystemPromptDialog
parent
- the button bar compositepublic SystemFilterStringEditPane getFilterStringEditPane(Shell shell)
ISystemChangeFilterPaneEditPaneSupplier
.
getFilterStringEditPane
in interface ISystemChangeFilterPaneEditPaneSupplier
protected boolean processOK()
processOK
in class SystemPromptDialog
protected boolean processCancel()
processCancel
in class SystemPromptDialog
public void setPageComplete(boolean complete)
setPageComplete
in interface ISystemPageCompleteListener
setPageComplete
in class SystemPromptDialog
complete
- complete indicator as set by the callerSystemBaseForm.addPageCompleteListener(ISystemPageCompleteListener)
public Shell getParentShell()
getParentShell
in class Window
null
if there is no parent shell
|
RSE Release 3.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |