|
install4j API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.install4j.api.beans.AbstractBean
com.install4j.api.screens.AbstractInstallerOrUninstallerScreen
public abstract class AbstractInstallerOrUninstallerScreen
Abstract base class for screens that can be used in the installer or uninstaller. All methods that have a reasonable default answer are overridden in the class. This class saves the context that is set by the framework and provides getters for it.
Constructor Summary | |
---|---|
AbstractInstallerOrUninstallerScreen()
|
Method Summary | |
---|---|
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. |
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 prorgess 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. |
boolean |
hasTitlePanel()
This method is called by the framework to determine if this screen wants a title area or not. |
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 |
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. |
Methods inherited from class com.install4j.api.beans.AbstractBean |
---|
replaceVariables, replaceVariables, replaceVariables, replaceVariables |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.install4j.api.screens.Screen |
---|
createComponent, getSubTitle, getTitle, isFillHorizontal, isFillVertical |
Constructor Detail |
---|
public AbstractInstallerOrUninstallerScreen()
Method Detail |
---|
public void setInstallerContext(InstallerContext context)
InstallerScreen
setInstallerContext
in interface InstallerScreen
context
- the installer context.public void setUninstallerContext(UninstallerContext context)
UninstallerScreen
setUninstallerContext
in interface UninstallerScreen
context
- the uninstaller context.public boolean isNextVisible()
Screen
In console or unattended mode, this method is never called.
isNextVisible
in interface Screen
WizardContext
public boolean isPreviousVisible()
Screen
In console or unattended mode, this method is never called.
isPreviousVisible
in interface Screen
WizardContext
public boolean isCancelVisible()
Screen
In console or unattended mode, this method is never called.
isCancelVisible
in interface Screen
WizardContext
public boolean isHiddenForNext()
Screen
This method is also called in console or unattended mode.
isHiddenForNext
in interface Screen
public boolean isHiddenForPrevious()
Screen
This method is also called in console or unattended mode.
isHiddenForPrevious
in interface Screen
public void activated()
Screen
In console or unattended mode, this method is never called.
activated
in interface Screen
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
In console or unattended mode, this method is never called.
next
in interface Screen
public boolean previous()
Screen
In console or unattended mode, this method is never called.
previous
in interface Screen
public boolean cancel()
Screen
cancel
in interface Screen
In console or unattended mode, this method is never called.
public void willActivate()
Screen
In console or unattended mode, this method is never called.
willActivate
in interface Screen
public boolean isHidden()
Screen
This method is also called in console or unattended mode.
isHidden
in interface Screen
Screen.isHiddenForNext()
,
Screen.isHiddenForPrevious()
public boolean handleUnattended()
Screen
handleUnattended
in interface Screen
public boolean handleConsole(Console console) throws UserCanceledException
Screen
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 object
UserCanceledException
- 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 interface
public boolean hasTitlePanel()
Screen
hasTitlePanel
in interface Screen
public InstallerContext getInstallerContext()
public UninstallerContext getUninstallerContext()
public Context getContext()
|
install4j API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |