com.sap.tc.webdynpro.services.session.api
Interface IWDWindow

All Known Subinterfaces:

IWDConfirmationDialog

public interface IWDWindow

Application API for windows

Field Summary

static java.lang.String	WINDOW_BOTTOM_POSITION
static java.lang.String	WINDOW_LEFT_POSITION
static java.lang.String	WINDOW_POSITION_CENTERED
static java.lang.String	WINDOW_RIGHT_POSITION
static java.lang.String	WINDOW_TOP_POSITION

Method Summary

void	close() Method close - closes the window but the instance is not destroyed -> reopen is possible.
void	destroy() Method destroy: invalidates/destroys window instance - the instance is closed and destroyed and can not be reused/reopened
boolean	isModal() Method isModal - checks if the window is modal.
boolean	isTopLevel() Method isTopLevel - returns if the window is the root window.
void	open() Method opens the window.
void	removeWindowFeature(WDWindowFeature feature) Method removes a window feature in the window instance.
void	setWindowPosition(int left, int top) Method setWindowPosition - sets the absolute window position of the window in "px".
void	setWindowPosition(WDCssSize left, WDCssSize top) Method setWindowPosition - sets the absolute window position of the window.
void	setWindowPosition(WDWindowPos position) Method setWindowPosition - sets a relative position of the window, e.g.
void	setWindowSize(int width, int height) Method setWindowSize - sets the window size in "px".
void	setWindowSize(WDCssSize width, WDCssSize height) Method setWindowSize - sets the window size.

Field Detail

WINDOW_LEFT_POSITION

public static final java.lang.String WINDOW_LEFT_POSITION

WINDOW_RIGHT_POSITION

public static final java.lang.String WINDOW_RIGHT_POSITION

WINDOW_TOP_POSITION

public static final java.lang.String WINDOW_TOP_POSITION

WINDOW_BOTTOM_POSITION

public static final java.lang.String WINDOW_BOTTOM_POSITION

WINDOW_POSITION_CENTERED

public static final java.lang.String WINDOW_POSITION_CENTERED

Method Detail

close

public void close()

Method close - closes the window but the instance is not destroyed -> reopen is possible.

isTopLevel

public boolean isTopLevel()

Method isTopLevel - returns if the window is the root window.

Returns:

boolean - true if it is root window

isModal

public boolean isModal()

Method isModal - checks if the window is modal.

Returns:

boolean - true if it is modal

setWindowSize

public void setWindowSize(int width,
                          int height)

Method setWindowSize - sets the window size in "px". As default values the maximum is set.

Parameters:

width - - the width of the window

height - - the height ot the window

setWindowSize

public void setWindowSize(WDCssSize width,
                          WDCssSize height)

Method setWindowSize - sets the window size. As default values the maximum is set.

Parameters:

width - - the width of the window

height - - the height ot the window

setWindowPosition

public void setWindowPosition(int left,
                              int top)

Method setWindowPosition - sets the absolute window position of the window in "px".

Parameters:

left - - the horizontal position - default is 0 -> left side

top - - the vertical position - default is 0 -> on the top

setWindowPosition

public void setWindowPosition(WDCssSize left,
                              WDCssSize top)

Method setWindowPosition - sets the absolute window position of the window.

Parameters:

left - - the horizontal position - default is 0 -> left side

top - - the vertical position - default is 0 -> on the top

setWindowPosition

public void setWindowPosition(WDWindowPos position)

Method setWindowPosition - sets a relative position of the window, e.g. centered, use constants of WDWindowPos to set the value

Parameters:

posType - - default is absolute position

open

public void open()

Method opens the window. In the current request/response- cycle, no further manipulations are allowed

destroy

public void destroy()

Method destroy: invalidates/destroys window instance - the instance is closed and destroyed and can not be reused/reopened

removeWindowFeature

public void removeWindowFeature(WDWindowFeature feature)

Method removes a window feature in the window instance. Removing a feature is valid until the window is opened, afterwards the window has to be closed for removing other features. default is that all window features are added.