org.olat.core.gui.control
Interface WindowControl

All Known Implementing Classes:

BusinessGroupManagerImplTest, EnrollmentManagerTest, LocalWindowControl, StackedBusinessWindowControl

public interface WindowControl

Description:
an Interface to control some Gui things like messages, navigational issues, modal dialogs etc; It is passed from Controller to all subcontrollers to allow the setting of info, warn, and error messages and to activate/deactivate modal dialogs and to replace the complete gui stack (e.g. when a header link is chosen)

Author:

Felix Jost

Method Summary

BusinessControl	getBusinessControl()
WindowBackOffice	getWindowBackOffice()
WindowControlInfo	getWindowControlInfo()
void	makeFlat() Use only when coding the Activatable interface.
void	pop()
void	pushAsModalDialog(Component comp)
void	pushToMainArea(Component comp) Deprecated. todo merge with pushAsModalDialog (pb)
void	setError(java.lang.String string)
void	setInfo(java.lang.String string)
void	setWarning(java.lang.String string)

Method Detail

pushToMainArea

void pushToMainArea(Component comp)

Deprecated. todo merge with pushAsModalDialog (pb)

put the component on the stack pane of the -current- guistack. useful for modal dialogs and such.

Parameters:

comp -

pushAsModalDialog

void pushAsModalDialog(Component comp)

Parameters:

comp -

pop

void pop()

setInfo

void setInfo(java.lang.String string)

Parameters:

string -

setError

void setError(java.lang.String string)

Parameters:

string -

setWarning

void setWarning(java.lang.String string)

Parameters:

string -

getWindowControlInfo

WindowControlInfo getWindowControlInfo()

Returns:

the windowcontrolinfo

makeFlat

void makeFlat()

Use only when coding the Activatable interface. flatens (that is, does 0 to n pop() 's to the level where this windowcontrol is located. Useful only when implementing the Activatable interface to dump all possible pushed components and return to "the base" which is the level at which the controller's initialcomponent resides.

getBusinessControl

BusinessControl getBusinessControl()

Returns:

the businesscontrol, never null

getWindowBackOffice

WindowBackOffice getWindowBackOffice()