|
install4j API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Screen
The base interface for all screens. Do not implement this interface directly, only the derived interfaces are functional. It is recommended that you choose one of the derived abstract classes as a super class. The life-cycle of screens is controlled by the framework.
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. |
javax.swing.JComponent |
createComponent()
Return the visual component that is displayed for the screen. |
void |
deactivated()
Called by the framework just after the screen has been deactivated. |
ProgressInterface |
getProgressInterface(ProgressInterface defaultProgressInterface)
Replace the default prorgess interface for actions with a custom progress interface. |
java.lang.String |
getSubTitle()
Returns the subtitle of this custom screen which is displayed at the top of the installer wizard just below the title of the screen. |
java.lang.String |
getTitle()
Returns the title of this custom screen which is displayed at the top of the installer wizard. |
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. |
boolean |
isCancelVisible()
Returns whether the "Cancel" button is visible or not for this screen. |
boolean |
isFillHorizontal()
Returns whether this screen wants to grow in the horizontal direction. |
boolean |
isFillVertical()
Returns whether this screen wants to grow in the vertical direction. |
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 |
willActivate()
Called by the framework just before the screen is activated. |
Method Detail |
---|
javax.swing.JComponent createComponent()
In console or unattended mode, this method is never called.
java.lang.String getTitle()
In console or unattended mode, this method is never called.
java.lang.String getSubTitle()
In unattended mode, this method is never called. In console mode, the result of this method will be displayed for each screen.
boolean isFillVertical()
In console or unattended mode, this method is never called.
isFillHorizontal()
boolean isFillHorizontal()
In console or unattended mode, this method is never called.
isFillVertical()
boolean isNextVisible()
In console or unattended mode, this method is never called.
WizardContext
boolean isPreviousVisible()
In console or unattended mode, this method is never called.
WizardContext
boolean isCancelVisible()
In console or unattended mode, this method is never called.
WizardContext
void willActivate()
In console or unattended mode, this method is never called.
void activated()
In console or unattended mode, this method is never called.
void deactivated()
In console or unattended mode, this method is never called.
boolean next()
In console or unattended mode, this method is never called.
boolean previous()
In console or unattended mode, this method is never called.
boolean cancel()
In console or unattended mode, this method is never called.
boolean isHiddenForNext()
This method is also called in console or unattended mode.
boolean isHiddenForPrevious()
This method is also called in console or unattended mode.
boolean isHidden()
This method is also called in console or unattended mode.
isHiddenForNext()
,
isHiddenForPrevious()
boolean handleUnattended()
boolean handleConsole(Console console) throws UserCanceledException
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.
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)
ProgressInterface getProgressInterface(ProgressInterface defaultProgressInterface)
defaultProgressInterface
- the default progress interface
boolean hasTitlePanel()
|
install4j API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |