org.olat.core.gui.control.info
Interface WindowControlInfo

All Known Implementing Classes:
WindowControlInfoImpl

public interface WindowControlInfo

Description:
Initial Date: 09.09.2005

Author:
Felix Jost

Method Summary
 void addChild(WindowControlInfo child)
          to be called only by the constructor of a windowcontrolinfo.
 void adjustControllerState(boolean back, ExtendedControllerState ecstate, UserRequest ureq)
          the implementation must somehow call back to the controller to let it adjust its state to the new state.
 java.util.List<WindowControlInfo> getChildren()
           
 java.lang.String getControllerClassName()
           
 ExtendedControllerState getExtendedControllerState()
           
 WindowControlInfo getParentWindowControlInfo()
           
 boolean isControllerDisposed()
           
 

Method Detail

getControllerClassName

java.lang.String getControllerClassName()
Returns:

getParentWindowControlInfo

WindowControlInfo getParentWindowControlInfo()

getExtendedControllerState

ExtendedControllerState getExtendedControllerState()
Returns:
the controllerstate of the underlying controller

adjustControllerState

void adjustControllerState(boolean back,
                           ExtendedControllerState ecstate,
                           UserRequest ureq)
the implementation must somehow call back to the controller to let it adjust its state to the new state.

Parameters:
ecstate - the new state to adjust to
back - if true, the transition direction is back, that is from end to start, otherwise it is forward (from start to end)
ureq - the UserRequest: using as normal, but calling ureq.getParameter(...) doesn't make sense here, since those are the parameters of a call in the past.

getChildren

java.util.List<WindowControlInfo> getChildren()
Returns:
null or a list (non-empty) of currently non-disposed WindowControlInfos

addChild

void addChild(WindowControlInfo child)
to be called only by the constructor of a windowcontrolinfo.

Parameters:
impl -

isControllerDisposed

boolean isControllerDisposed()
Returns: