Package org.esa.snap.ui.assistant

Class AssistantPane

java.lang.Object

org.esa.snap.ui.assistant.AssistantPane

All Implemented Interfaces:

AssistantPageContext

Direct Known Subclasses:

LayerSourceAssistantPane

public class AssistantPane
extends Object
implements AssistantPageContext

Shows a sequence of assitant pages with an dialog.

Constructor Summary

Constructors

Constructor	Description
AssistantPane(Window parent, String title)	Creates a new AssistantPane.

Method Summary

Modifier and Type	Method	Description
AssistantPage	getCurrentPage()	Gets the currently displayed page.
Window	getWindow()	The window in which the AssistantPage is shown.
void	setCurrentPage(AssistantPage currentPage)	Sets the currently displayed page.
void	show(AssistantPage firstPage)	Displays the dialog if this AssistantPane with the given page as first page.
void	show(AssistantPage firstPage, Rectangle bounds)	Displays the dialog if this AssistantPane with the given page as first page.
void	showErrorDialog(String message)	Shows an error dialog with the given message.
void	updateState()	Forces an updated of the state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssistantPane

public AssistantPane(Window parent,
                     String title)

Creates a new AssistantPane.

Parameters:

parent - The parent window.

title - The title of the dialog.

Method Detail

getWindow

public Window getWindow()

Description copied from interface: AssistantPageContext

The window in which the AssistantPage is shown.

Specified by:

getWindow in interface AssistantPageContext

Returns:

The window.

getCurrentPage

public AssistantPage getCurrentPage()

Description copied from interface: AssistantPageContext

Gets the currently displayed page.

Specified by:

getCurrentPage in interface AssistantPageContext

Returns:

The current page.

setCurrentPage

public void setCurrentPage(AssistantPage currentPage)

Description copied from interface: AssistantPageContext

Sets the currently displayed page. Should only be called by the framwoerk.

Specified by:

setCurrentPage in interface AssistantPageContext

Parameters:

currentPage - The current page.

updateState

public void updateState()

Description copied from interface: AssistantPageContext

Forces an updated of the state.

Specified by:

updateState in interface AssistantPageContext

showErrorDialog

public void showErrorDialog(String message)

Description copied from interface: AssistantPageContext

Shows an error dialog with the given message.

Specified by:

showErrorDialog in interface AssistantPageContext

Parameters:

message - The error message to display.

show

public void show(AssistantPage firstPage)

Displays the dialog if this AssistantPane with the given page as first page.

Parameters:

firstPage - The first page which is displayed in the dialog.

show

public void show(AssistantPage firstPage,
                 Rectangle bounds)

Displays the dialog if this AssistantPane with the given page as first page.

Parameters:

firstPage - The first page which is displayed in the dialog.

bounds - The screen bounds of the window, may be null.