com.izforge.izpack.installer.panel
Interface Panels

All Known Subinterfaces:

PanelViews<T,V>

All Known Implementing Classes:

AbstractPanels, AutomatedPanels, ConsolePanels, IzPanels

public interface Panels

Manages navigation between panels.

Author:

Tim Anderson

Method Summary

int	getIndex() Returns the current panel index.
int	getNext(boolean visibleOnly) Determines if there is another panel after the current index.
int	getNext(int index, boolean visibleOnly) Determines if there is another panel after the specified index.
Panel	getPanel() Returns the current panel.
List<Panel>	getPanels() Returns the panels.
int	getPrevious(boolean visibleOnly) Determines if there is another panel prior to the current index.
int	getPrevious(int index, boolean visibleOnly) Determines if there is another panel prior to the specified index.
int	getVisible() Returns the number of visible panels.
boolean	hasNext() Determines if there is another panel after the current panel.
boolean	hasPrevious() Determines if there is panel prior to the current panel.
boolean	isValid() Determines if the current panel is valid.
boolean	next() Navigates to the next panel.
boolean	next(boolean validate) Navigates to the next panel.
boolean	previous() Navigates to the previous panel.
boolean	previous(int index) Navigates to the panel before the specified index.

Method Detail

getPanels

List<Panel> getPanels()

Returns the panels.

Returns:

the panels

getPanel

Panel getPanel()

Returns the current panel.

Returns:

the current panel, or null if there is no current panel

isValid

boolean isValid()

Determines if the current panel is valid.

Returns:

true if the current panel is valid

getIndex

int getIndex()

Returns the current panel index.

Returns:

the current panel index, or -1 if there is no current panel

hasNext

boolean hasNext()

Determines if there is another panel after the current panel.

Returns:

true if there is another panel

next

boolean next()

Navigates to the next panel.
Navigation can only occur if the current panel is valid.

Returns:

true if the next panel was navigated to

next

boolean next(boolean validate)

Navigates to the next panel.

Parameters:

validate - if true, only move to the next panel if validation succeeds

Returns:

true if the next panel was navigated to

hasPrevious

boolean hasPrevious()

Determines if there is panel prior to the current panel.

Returns:

true if there is a panel prior to the current panel

previous

boolean previous()

Navigates to the previous panel.

Returns:

true if the previous panel was navigated to

previous

boolean previous(int index)

Navigates to the panel before the specified index.
The target panel must be before the current panel.

Returns:

true if the previous panel was navigated to

getNext

int getNext(int index,
            boolean visibleOnly)

Determines if there is another panel after the specified index.

Parameters:

index - the panel index

visibleOnly - if true, only examine visible panels

Returns:

the next panel index, or -1 if there are no more panels

getNext

int getNext(boolean visibleOnly)

Determines if there is another panel after the current index.

Parameters:

visibleOnly - if true, only examine visible panels

Returns:

true if there is another panel

getPrevious

int getPrevious(int index,
                boolean visibleOnly)

Determines if there is another panel prior to the specified index.

Parameters:

index - the panel index

visibleOnly - if true, only examine visible panels

Returns:

the previous panel index, or -1 if there are no more panels

getPrevious

int getPrevious(boolean visibleOnly)

Determines if there is another panel prior to the current index.

Parameters:

visibleOnly - if true, only examine visible panels

Returns:

the previous panel index, or -1 if there are no more panels

getVisible

int getVisible()

Returns the number of visible panels.

Returns:

the number of visible panels