public abstract class AbstractInstallerOrUninstallerScreen extends AbstractBean implements InstallerScreen, UninstallerScreen, InstallerEventListener
Constructor and Description |
---|
AbstractInstallerOrUninstallerScreen() |
Modifier and Type | Method and Description |
---|---|
void |
activated()
Called by the framework just after the screen has been activated.
|
boolean |
cancel()
Called when the user clicks the "Cancel" button for this screen.
|
void |
deactivated()
Called by the framework just after the screen has been deactivated.
|
Anchor |
getAnchor()
Returns a default value for the anchor of the screen component.
|
Context |
getContext()
Returns the
Context that the framework has associated with
this custom screen in either setInstallerContext or setUninstallerContext . |
InstallerContext |
getInstallerContext()
Returns the
InstallerContext that the framework has associated with
this custom screen in setInstallerContext . |
ProgressInterface |
getProgressInterface(ProgressInterface defaultProgressInterface)
Replace the default progress interface for actions with a custom progress interface.
|
UninstallerContext |
getUninstallerContext()
Returns the
UninstallerContext that the framework has associated with
this custom screen in setUninstallerContext . |
boolean |
handleConsole(Console console)
Handle the console mode.
|
boolean |
handleUnattended()
Handle the unattended mode.
|
void |
installerEvent(InstallerEvent event)
Called when an installer event is fired.
|
boolean |
isCancelVisible()
Returns whether the "Cancel" button is visible or not for this screen.
|
boolean |
isCreateLazily()
This method is called by the framework to determine if the screen should only be created when it is shown.
|
boolean |
isHidden()
Returns whether this screen should be hidden.
|
boolean |
isHiddenForNext()
Returns whether this screen should be hidden when the user traverses screens
in the forward direction.
|
boolean |
isHiddenForPrevious()
Returns whether this screen should be hidden when the user traverses screens
in the backward direction.
|
boolean |
isNextVisible()
Returns whether the "Next" button is visible or not for this screen.
|
boolean |
isPreviousVisible()
Returns whether the "Back" button is visible or not for this screen.
|
boolean |
next()
Called when the user clicks the "Next" button for this screen.
|
boolean |
previous()
Called when the user clicks the "Back" button for this screen.
|
void |
setInstallerContext(InstallerContext context)
This method is called by the framework to set the
InstallerContext just after the
screen has been constructed. |
void |
setUninstallerContext(UninstallerContext context)
This method is called by the framework to set the
UninstallerContext . |
void |
willActivate()
Called by the framework just before the screen is activated.
|
executeActionListAsync, executeActionListSync, getTextOverrideValue, replaceVariables, replaceVariables, replaceVariables, replaceVariables, replaceVariables, replaceVariables, replaceVariables, replaceVariables, replaceWithTextOverride, replaceWithTextOverride, replaceWithTextOverride, replaceWithTextOverride, replaceWithTextOverride, replaceWithTextOverride, replaceWithTextOverride, replaceWithTextOverride, replaceWithTextOverride, replaceWithTextOverride, rollbackActionList
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
createComponent, getSubTitle, getTitle
isFillHorizontal, isFillVertical
public AbstractInstallerOrUninstallerScreen()
public void setInstallerContext(InstallerContext context)
InstallerScreen
InstallerContext
just after the
screen has been constructed.setInstallerContext
in interface InstallerScreen
context
- the installer context.public void setUninstallerContext(UninstallerContext context)
UninstallerScreen
UninstallerContext
.setUninstallerContext
in interface UninstallerScreen
context
- the uninstaller context.public boolean isNextVisible()
Screen
activate
and invoke setNextButtonEnabled
in the
WizardContext
that is available from the Context
in GUI mode.
In console or unattended mode, this method is never called.
isNextVisible
in interface Screen
true
or false
. Default is true
.WizardContext
public boolean isPreviousVisible()
Screen
activate
and invoke setPreviousButtonEnabled
in the
WizardContext
that is available from the Context
in GUI mode.
In console or unattended mode, this method is never called.
isPreviousVisible
in interface Screen
true
or false
. Default is true
.WizardContext
public boolean isCancelVisible()
Screen
activate
and invoke setCancelButtonEnabled
in the
WizardContext
that is available from the Context
in GUI mode.
In console or unattended mode, this method is never called.
isCancelVisible
in interface Screen
true
or false
. Default is true
.WizardContext
public boolean isHiddenForNext()
Screen
This method is also called in console or unattended mode.
isHiddenForNext
in interface Screen
true
or false
.public boolean isHiddenForPrevious()
Screen
This method is also called in console or unattended mode.
isHiddenForPrevious
in interface Screen
true
or false
.public void activated()
Screen
In console or unattended mode, this method is never called.
public void deactivated()
Screen
In console or unattended mode, this method is never called.
deactivated
in interface Screen
public void installerEvent(InstallerEvent event)
InstallerEventListener
installerEvent
in interface InstallerEventListener
event
- the eventpublic boolean next()
Screen
false
.
In console or unattended mode, this method is never called.
public boolean previous()
Screen
false
.
In console or unattended mode, this method is never called.
public boolean cancel()
Screen
false
.public void willActivate()
Screen
In console or unattended mode, this method is never called.
willActivate
in interface Screen
public Anchor getAnchor()
getAnchor
in interface VisualContainerBean
Anchor.NORTHWEST
VisualContainerBean.getAnchor()
public boolean isHidden()
Screen
true
,
it overrides the results of isHiddenForNext
and isHiddenForPrevious
.
This method is also called in console or unattended mode.
isHidden
in interface Screen
true
or false
.Screen.isHiddenForNext()
,
Screen.isHiddenForPrevious()
public boolean handleUnattended()
Screen
handleUnattended
in interface Screen
public boolean handleConsole(Console console) throws UserCanceledException
Screen
Console
object to interact with the user and replicate the GUI functionality
on the terminal.
If this screen has a form panel (i.e. hasFormPanel()
returns true
), you should call
FormEnvironment.handleConsole
in this method to handle console mode for the contained
form components.
handleConsole
in interface Screen
console
- the Console
objectUserCanceledException
- if the user cancels a question or notice. These exceptions are thrown by methods in the Console
object.FormEnvironment.handleConsole(Console)
public ProgressInterface getProgressInterface(ProgressInterface defaultProgressInterface)
Screen
getProgressInterface
in interface Screen
defaultProgressInterface
- the default progress interfacepublic boolean isCreateLazily()
Screen
Screen.createComponent()
can be called, then you should return true
in
this method.
If you have many screens that are created lazily and want to initialize them all at once, maybe after the
"Install files" action, you can call Context.initializeLazilyCreatedScreens()
.
isCreateLazily
in interface Screen
true
or false
.public InstallerContext getInstallerContext()
InstallerContext
that the framework has associated with
this custom screen in setInstallerContext
.null
if this screen is running in an uninstaller.public UninstallerContext getUninstallerContext()
UninstallerContext
that the framework has associated with
this custom screen in setUninstallerContext
.null
if this screen is running in an installer.public Context getContext()
Context
that the framework has associated with
this custom screen in either setInstallerContext
or setUninstallerContext
.