|
RSE Release 3.4 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.dialogs.DialogPage
org.eclipse.jface.preference.PreferencePage
org.eclipse.ui.dialogs.PropertyPage
org.eclipse.rse.ui.propertypages.SystemBasePropertyPage
public abstract class SystemBasePropertyPage
A base class for property pages that offers value over the base Eclipse PropertyPage class:
ISystemMessageLine message methods.
verifyPageContents()
To get these benefits you must override createContentArea(Composite) instead of createContents.
Our base implementation of createContents configures the message line and then calls
createContentArea and then assigns mnemonics to the content area.
| Field Summary | |
|---|---|
protected Composite |
buttonsComposite
|
protected Composite |
contentArea
|
protected ISystemMessageLine |
msgLine
|
protected boolean |
msgLineSet
|
| Fields inherited from interface org.eclipse.jface.dialogs.IMessageProvider |
|---|
ERROR, INFORMATION, NONE, WARNING |
| Constructor Summary | |
|---|---|
SystemBasePropertyPage()
Constructor for SystemBasePropertyPage |
|
| Method Summary | |
|---|---|
protected Label |
addFillerLine(Composite parent,
int nbrColumns)
Helper method. |
protected Label |
addSeparatorLine(Composite parent,
int nbrColumns)
Helper method. |
void |
clearErrorMessage()
ISystemMessageLine method. |
void |
clearMessage()
ISystemMessageLine method. |
protected void |
configureMessageLine()
Private. |
protected void |
contributeButtons(Composite buttonBar)
Private. |
protected abstract Control |
createContentArea(Composite parent)
Abstract. |
protected Control |
createContents(Composite parent)
Parent intercept. |
protected Combo |
createLabeledCombo(Composite c,
String label,
String tooltip)
Create a labeled combo, where the combo on the right grabs excess space and has an indent so it isn't smashed up against the prompt on the left. |
protected Label |
createLabeledLabel(Composite c,
String label,
String tooltip)
Create a labeled label, where the label on the right grabs excess space and has an indent so it isn't smashed up against the prompt on the left. |
protected Text |
createLabeledText(Composite c,
String label,
String tooltip)
Create a labeled entry field, where the field on the right grabs excess space and has an indent so it isn't smashed up against the prompt on the left. |
protected Label |
createLabeledVerbiage(Composite c,
String label,
String tooltip)
Create a labeled verbiage field, where the field on the right grabs excess space and has an indent so it isn't smashed up against the prompt on the left. |
ISystemMessageLine |
getMessageLine()
ISystemMessageLineTarget method. |
SystemMessage |
getSystemErrorMessage()
ISystemMessageLine method. |
protected Control |
grabExcessSpace(Control control)
Sets this control to grab any excess horizontal space left in the window. |
boolean |
okToLeave()
Parent intercept. |
boolean |
performOk()
Method declared on IPreferencePage. |
void |
setBusyCursor(boolean setBusy)
Helper method. |
void |
setErrorMessage(String message)
ISystemMessageLine method. |
void |
setErrorMessage(SystemMessage message)
ISystemMessageLine method. |
void |
setErrorMessage(Throwable exc)
ISystemMessageLine method. |
void |
setHelp(String helpId)
For setting the default overall help for the dialog. |
void |
setMessage(String message)
ISystemMessageLine method. |
void |
setMessage(SystemMessage message)
ISystemMessageLine method. |
void |
setMessageLine(ISystemMessageLine msgLine)
ISystemMessageLineTarget method. |
protected abstract boolean |
verifyPageContents()
Abstract. |
protected boolean |
wantAutomaticValidManagement()
Configuration method. |
protected boolean |
wantDefaultAndApplyButton()
Configuration method. |
protected boolean |
wantMnemonics()
Configuration method. |
| Methods inherited from class org.eclipse.ui.dialogs.PropertyPage |
|---|
getElement, setElement |
| Methods inherited from class org.eclipse.jface.preference.PreferencePage |
|---|
applyData, applyDialogFont, computeSize, createControl, createDescriptionLabel, createNoteComposite, doComputeSize, doGetPreferenceStore, getApplyButton, getContainer, getDefaultsButton, getPreferenceStore, isValid, noDefaultAndApplyButton, performApply, performCancel, performDefaults, performHelp, setContainer, setMessage, setPreferenceStore, setSize, setTitle, setValid, toString, updateApplyButton |
| Methods inherited from class org.eclipse.jface.dialogs.DialogPage |
|---|
convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, dispose, getControl, getDescription, getDialogFontName, getErrorMessage, getFont, getImage, getMessage, getMessageType, getShell, getTitle, getToolTipText, initializeDialogUnits, isControlCreated, setButtonLayoutData, setControl, setDescription, setImageDescriptor, setVisible |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.eclipse.rse.ui.messages.ISystemMessageLine |
|---|
getErrorMessage, getMessage |
| Methods inherited from interface org.eclipse.jface.preference.IPreferencePage |
|---|
computeSize, isValid, performCancel, setContainer, setSize |
| Methods inherited from interface org.eclipse.jface.dialogs.IDialogPage |
|---|
createControl, dispose, getControl, getDescription, getErrorMessage, getImage, getMessage, getTitle, performHelp, setDescription, setImageDescriptor, setTitle, setVisible |
| Field Detail |
|---|
protected ISystemMessageLine msgLine
protected boolean msgLineSet
protected Composite contentArea
protected Composite buttonsComposite
| Constructor Detail |
|---|
public SystemBasePropertyPage()
| Method Detail |
|---|
protected Control createContents(Composite parent)
createContentArea(Composite) and then assigns mnemonics to the content area.
Also calls PreferencePage.noDefaultAndApplyButton() if wantDefaultAndApplyButton() returns false.
createContents in class PreferencePagePreferencePage.createContents(Composite),
createContentArea(Composite)protected boolean wantDefaultAndApplyButton()
protected boolean wantMnemonics()
protected boolean wantAutomaticValidManagement()
public void setHelp(String helpId)
SystemWidgetHelpers.setHelp(Control, String)
protected abstract Control createContentArea(Composite parent)
protected void configureMessageLine()
protected void contributeButtons(Composite buttonBar)
contributeButtons in class PreferencePagepublic boolean okToLeave()
PreferencePage implementation of this
IPreferencePage method returns true
if the page is valid.
We first test isValid() just like our parent implementation does, but since that only represents the valid state of the last control the user interacted with, we also call verifyPageContents.
Subclasses must override verifyPageContents() to do full error checking on all
the widgets on the page.
okToLeave in interface IPreferencePageokToLeave in class PreferencePageprotected abstract boolean verifyPageContents()
Subclasses should override to do full error checking on all the widgets on the page. Recommendation:
SystemMessage via setErrorMessage(SystemMessage) or text message via setErrorMessage(String).
clearErrorMessage()
public boolean performOk()
performOk in interface IPreferencePageperformOk in class PreferencePagepublic void setMessageLine(ISystemMessageLine msgLine)
setMessageLine in interface ISystemMessageLineTargetpublic ISystemMessageLine getMessageLine()
getMessageLine in interface ISystemMessageLineTargetpublic void setBusyCursor(boolean setBusy)
protected Label addSeparatorLine(Composite parent,
int nbrColumns)
protected Label addFillerLine(Composite parent,
int nbrColumns)
protected Control grabExcessSpace(Control control)
control - the control for which to grab excess space
protected Label createLabeledLabel(Composite c,
String label,
String tooltip)
SystemWidgetHelpers.createLabeledLabel(Composite, String, String, boolean),
grabExcessSpace(Control)
protected Combo createLabeledCombo(Composite c,
String label,
String tooltip)
SystemWidgetHelpers.createLabeledCombo(Composite, Listener, String, String),
grabExcessSpace(Control)
protected Text createLabeledText(Composite c,
String label,
String tooltip)
SystemWidgetHelpers.createLabeledTextField(Composite, Listener, String, String),
grabExcessSpace(Control)
protected Label createLabeledVerbiage(Composite c,
String label,
String tooltip)
SystemWidgetHelpers.createLabeledTextField(Composite, Listener, String, String),
grabExcessSpace(Control)public void clearErrorMessage()
clearErrorMessage in interface ISystemMessageLinepublic void clearMessage()
clearMessage in interface ISystemMessageLinepublic SystemMessage getSystemErrorMessage()
getSystemErrorMessage in interface ISystemMessageLinenull is returned.public void setErrorMessage(String message)
setErrorMessage in interface ISystemMessageLinesetErrorMessage in class PreferencePagepublic void setErrorMessage(SystemMessage message)
setErrorMessage in interface ISystemMessageLinepublic void setErrorMessage(Throwable exc)
setErrorMessage in interface ISystemMessageLinepublic void setMessage(SystemMessage message)
setMessage in interface ISystemMessageLinepublic void setMessage(String message)
setMessage in interface ISystemMessageLinesetMessage in class DialogPage
|
RSE Release 3.4 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||