public abstract class GuiApplication extends Application
Application.ErrorPrintStream, Application.OutputPrintStream, Application.PointAdder
formatter, installStatus, tempLogFile
Constructor and Description |
---|
GuiApplication()
Constructs an instance of an application.
|
Modifier and Type | Method and Description |
---|---|
protected void |
acceptCertificateForException(UserDataCertificateException ce,
boolean acceptPermanently)
Updates the list of certificates accepted by the user in the trust manager
based on the information stored in the UserDataCertificateException we got
when trying to connect in secure mode.
|
abstract boolean |
canFinish(WizardStep step)
Indicates whether the user is allowed to finish the wizard from
step . |
boolean |
canGoBack(WizardStep step)
Indicates whether the user is allowed to return to a previous
step from
step . |
boolean |
canGoForward(WizardStep step)
Indicates whether the user is allowed to move to a new
step from
step . |
void |
closeClicked(WizardStep cStep,
QuickSetup qs)
Called when the user has clicked the 'close' button.
|
boolean |
confirmCancel(QuickSetup qs)
Called before the application cancels its operation, giving the
user a chance to confirm the cancellation action.
|
JPanel |
createFramePanel(QuickSetupDialog dlg)
Creates the main panel for the wizard dialog.
|
abstract QuickSetupStepPanel |
createWizardStepPanel(WizardStep step)
Creates a wizard panel given a specific step.
|
abstract boolean |
finishClicked(WizardStep cStep,
QuickSetup qs)
Called when the user has clicked the 'finish' button.
|
boolean |
finishOnLeft()
Indicates whether the finish button must be placed on the left (close to
"Next" button) or on the right (close to "Quit" button).
|
void |
forceToDisplay()
This method is called when we detected that there is something installed
we inform of this to the user and the user wants to proceed with the
installation destroying the contents of the data and the configuration
in the current installation.
|
LocalizableMessage |
getCloseButtonToolTip()
Gets the key for the close button's tool tip text.
|
WizardStep |
getCurrentWizardStep()
Gets the currently displayed wizard step.
|
int |
getExtraDialogHeight()
Gets the amount of addition pixels added to the height
of the tallest panel in order to size the wizard for
asthetic reasons.
|
LocalizableMessage |
getFinishButtonLabel()
Gets the key for the finish button's label.
|
LocalizableMessage |
getFinishButtonToolTip()
Gets the key for the finish button's tool tip text.
|
abstract WizardStep |
getFinishedStep()
Gets the finished step in the wizard.
|
abstract WizardStep |
getFirstWizardStep()
Returns the initial wizard step.
|
abstract LocalizableMessage |
getFrameTitle()
Gets the frame title of the GUI application that will be used
in some operating systems.
|
abstract ButtonName |
getInitialFocusButtonName()
Get the name of the button that will receive initial focus.
|
abstract WizardStep |
getNextWizardStep(WizardStep step)
Gets the next step in the wizard given a current step.
|
LinkedHashSet<WizardStep> |
getOrderedSteps()
Returns the list of all the steps in an ordered manner.
|
abstract WizardStep |
getPreviousWizardStep(WizardStep step)
Gets the previous step in the wizard given a current step.
|
LocalizableMessage |
getQuitButtonToolTip()
Gets the key for the quit button's tool tip text.
|
protected LocalizableMessage |
getTab()
Returns the tab formatted.
|
String[] |
getUserArguments()
Returns the arguments passed in the command-line to launch the application.
|
abstract Set<? extends WizardStep> |
getWizardSteps()
Returns the set of wizard steps used in this application's wizard.
|
boolean |
isSubStep(WizardStep step)
Indicates whether the provided
step is a sub step or not. |
boolean |
isVisible(WizardStep step,
QuickSetup qs)
Indicates whether the provided
step is visible or not
depending on the contents of the QuickSetup object that is provided. |
boolean |
isVisible(WizardStep step,
UserData userData)
Indicates whether the provided
step is visible or not
depending on the contents of the UserData object that is provided. |
abstract void |
nextClicked(WizardStep cStep,
QuickSetup qs)
Called when the user has clicked the 'next' button.
|
abstract void |
previousClicked(WizardStep cStep,
QuickSetup qs)
Called when the user has clicked the 'previous' button.
|
void |
quitClicked(WizardStep step,
QuickSetup qs)
Called when the user has clicked the 'quit' button.
|
void |
setDisplayedWizardStep(WizardStep step,
UserData userData,
QuickSetupDialog dlg)
Called by the quicksetup controller when the user advances to
a new step in the wizard.
|
void |
setQuickSetupDialog(QuickSetupDialog dialog)
Sets the QuickSetupDialog driving this application.
|
void |
setUserArguments(String[] args)
Sets the arguments passed in the command-line to launch the application.
|
abstract void |
setWizardDialogState(QuickSetupDialog dlg,
UserData userData,
WizardStep step)
Called when the user advances to new step in the wizard.
|
abstract void |
updateUserData(WizardStep cStep,
QuickSetup qs)
Called whenever this application should update its user data from
values found in QuickSetup.
|
abstract void |
windowClosing(QuickSetupDialog dlg,
WindowEvent evt)
Called by the controller when the window is closing.
|
addProgressUpdateListener, applicationPrintStreamReceived, cancel, checkAbort, create, createUserData, getApplicationErrorStream, getApplicationOutputStream, getCurrentProgressStep, getFormattedDone, getFormattedDoneWithLineBreak, getFormattedError, getFormattedError, getFormattedLog, getFormattedLogError, getFormattedProgress, getFormattedProgressWithLineBreak, getFormattedSuccess, getFormattedSummary, getFormattedWarning, getFormattedWithPoints, getInstallation, getInstallationPath, getInstancePath, getLineBreak, getMessage, getProgressMessageFormatter, getRatio, getRemoteConnection, getSummary, getTaskSeparator, getTrustManager, getUserData, isCancellable, isFinished, isVerbose, notifyListeners, notifyListeners, notifyListenersDone, notifyListenersRatioChange, notifyListenersWithPoints, removeProgressUpdateListener, setCurrentInstallStatus, setInstallation, setNotifyListeners, setProgressMessageFormatter, setTempLogFile, setUserData
public GuiApplication()
public abstract LocalizableMessage getFrameTitle()
public abstract WizardStep getFirstWizardStep()
public void setDisplayedWizardStep(WizardStep step, UserData userData, QuickSetupDialog dlg)
step
- Step indicating the new current stepuserData
- UserData representing the data specified by the userdlg
- QuickSetupDialog hosting the wizardpublic abstract void setWizardDialogState(QuickSetupDialog dlg, UserData userData, WizardStep step)
dlg
- QuickSetupDialog hosting the wizarduserData
- UserData representing the data specified by the userstep
- Step indicating the new current stepprotected LocalizableMessage getTab()
public abstract void windowClosing(QuickSetupDialog dlg, WindowEvent evt)
dlg
- QuickSetupDialog that will be closingevt
- The event from the Window indicating closingpublic void forceToDisplay()
public boolean confirmCancel(QuickSetup qs)
qs
- QuickSetup that can be used for confirmingpublic abstract ButtonName getInitialFocusButtonName()
public JPanel createFramePanel(QuickSetupDialog dlg)
dlg
- QuickSetupDialog usedpublic abstract Set<? extends WizardStep> getWizardSteps()
public abstract QuickSetupStepPanel createWizardStepPanel(WizardStep step)
step
- for which a panel representation should be createdstep
public abstract WizardStep getNextWizardStep(WizardStep step)
step
- Step the current steppublic abstract WizardStep getPreviousWizardStep(WizardStep step)
step
- Step the current steppublic abstract WizardStep getFinishedStep()
public WizardStep getCurrentWizardStep()
public boolean isSubStep(WizardStep step)
step
is a sub step or not.step
- WizardStep for which the return value indicates whether
or not is a sub step.step
is a
substep.public boolean isVisible(WizardStep step, UserData userData)
step
is visible or not
depending on the contents of the UserData object that is provided.step
- WizardStep for which the return value indicates whether
or not is visible.userData
- the UserData to be used to determine if the step is
visible or not.step
is
visible.public boolean isVisible(WizardStep step, QuickSetup qs)
step
is visible or not
depending on the contents of the QuickSetup object that is provided.step
- WizardStep for which the return value indicates whether
or not is visible.qs
- the QuickSetup to be used to determine if the step is
visible or not.step
is
visible.public LinkedHashSet<WizardStep> getOrderedSteps()
public boolean canGoBack(WizardStep step)
step
.step
- WizardStep for which the the return value indicates whether
or not the user can return to a previous stepstep
public boolean canGoForward(WizardStep step)
step
.step
- WizardStep for which the the return value indicates whether
or not the user can move to a new stepstep
public abstract boolean canFinish(WizardStep step)
step
.step
- WizardStep for which the the return value indicates whether
or not the user can finish the wizardpublic abstract void previousClicked(WizardStep cStep, QuickSetup qs)
cStep
- WizardStep at which the user clicked the previous buttonqs
- QuickSetup controllerpublic abstract boolean finishClicked(WizardStep cStep, QuickSetup qs)
cStep
- WizardStep at which the user clicked the previous buttonqs
- QuickSetup controllerpublic abstract void nextClicked(WizardStep cStep, QuickSetup qs)
cStep
- WizardStep at which the user clicked the next buttonqs
- QuickSetup controllerpublic void closeClicked(WizardStep cStep, QuickSetup qs)
cStep
- WizardStep at which the user clicked the close buttonqs
- QuickSetup controllerpublic void quitClicked(WizardStep step, QuickSetup qs)
step
- WizardStep at which the user clicked the quit buttonqs
- QuickSetup controllerpublic abstract void updateUserData(WizardStep cStep, QuickSetup qs) throws UserDataException
cStep
- current wizard stepqs
- QuickSetup controllerUserDataException
- if there is a problem with
the datapublic LocalizableMessage getCloseButtonToolTip()
public LocalizableMessage getQuitButtonToolTip()
public LocalizableMessage getFinishButtonToolTip()
public LocalizableMessage getFinishButtonLabel()
public boolean finishOnLeft()
true
if the finish button must be placed on the left
and false
otherwise.protected void acceptCertificateForException(UserDataCertificateException ce, boolean acceptPermanently)
ce
- the UserDataCertificateException that contains the information to
be used.acceptPermanently
- whether the certificate must be accepted
permanently or not.public int getExtraDialogHeight()
public void setQuickSetupDialog(QuickSetupDialog dialog)
dialog
- QuickSetupDialog driving this applicationpublic void setUserArguments(String[] args)
args
- the arguments passed in the command-line to launch the
application.public String[] getUserArguments()
Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.