Dashboard

Class EmbeddedWidgetWindow

java.lang.Object

Dashboard.EmbeddedWidgetWindow

public class EmbeddedWidgetWindow
extends Object

Class that is used to display a embedded widget in a window

Constructor Summary

Constructors

Constructor and Description
EmbeddedWidgetWindow(EmbeddedWidget p_embeddedWidget!) Constructs a EmbeddedWidgetWindow
EmbeddedWidgetWindow(EmbeddedWidget p_embeddedWidget!, BBjNumber p_width, BBjNumber p_height) Constructs a EmbeddedWidgetWindow passing in a desired width and height

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the EmbeddedWidgetWindow
void	doModal() Shows the embedded widget window modally, returns when the window is closed
EmbeddedWidgetControl	getEmbeddedWidgetControl() Returns the encapsulated EmbeddedWidgetControl
BBjNumber	getHeight() Returns the height of the EmbeddedWidgetWindow
BBjNumber	getWidth() Returns the width of the EmbeddedWidgetWindow
BBjNumber	getX() Returns the X location of the EmbeddedWidgetWindow
BBjNumber	getY() Returns the Y location of the EmbeddedWidgetWindow
BBjNumber	isDestroyed() Returns if the EmbeddedWidgetWindow is destroyed
BBjNumber	isVisible() Returns the visiblity of the EmbeddedWidgetWindow
void	setLocation(BBjNumber p_x, BBjNumber p_y) Sets the location of the EmbeddedWidgetWindow
void	setSize(BBjNumber p_width, BBjNumber p_height) Sets the size of the EmbeddedWidgetWindow
void	setTitle(BBjString p_title$) Sets the title of the EmbeddedWidgetWindow
void	setVisible(BBjNumber p_visible) Sets the visiblity of the EmbeddedWidgetWindow

Methods inherited from class java.lang.Object

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

Constructor Detail

EmbeddedWidgetWindow

public EmbeddedWidgetWindow(EmbeddedWidget p_embeddedWidget!)

Constructs a EmbeddedWidgetWindow

Parameters:

p_embeddedWidget! - EmbeddedWidget to be displayed in the window

EmbeddedWidgetWindow

public EmbeddedWidgetWindow(EmbeddedWidget p_embeddedWidget!,
BBjNumber p_width,
BBjNumber p_height)

Constructs a EmbeddedWidgetWindow passing in a desired width and height

Parameters:

p_embeddedWidget! - EmbeddedWidget to be displayed in the window

p_width - The width of the window

p_height - The height of the window

Method Detail

doModal

public void doModal()

Shows the embedded widget window modally, returns when the window is closed

setTitle

public void setTitle(BBjString p_title$)

Sets the title of the EmbeddedWidgetWindow

Parameters:

p_title$ - Title for the EmbeddedWidgetWindow.

setSize

public void setSize(BBjNumber p_width,
BBjNumber p_height)

Sets the size of the EmbeddedWidgetWindow

Parameters:

p_width - Width of the EmbeddedWidgetWindow.

p_height - Height of the EmbeddedWidgetWindow.

setVisible

public void setVisible(BBjNumber p_visible)

Sets the visiblity of the EmbeddedWidgetWindow

Parameters:

p_visible - Indicates the visiblity of the EmbeddedWidgetWindow. 0 = invisible, 1 = visible

getX

public BBjNumber getX()

Returns the X location of the EmbeddedWidgetWindow

Returns:

Returns the X locations of the EmbeddedWidgetWindow

getY

public BBjNumber getY()

Returns the Y location of the EmbeddedWidgetWindow

Returns:

Returns the Y locations of the EmbeddedWidgetWindow

setLocation

public void setLocation(BBjNumber p_x,
BBjNumber p_y)

Sets the location of the EmbeddedWidgetWindow

Parameters:

p_x - Horizontal position of the EmbeddedWidgetWindow in current units

p_y - Vertical position of the EmbeddedWidgetWindow in current units

getWidth

public BBjNumber getWidth()

Returns the width of the EmbeddedWidgetWindow

Returns:

Returns the width of the EmbeddedWidgetWindow

getHeight

public BBjNumber getHeight()

Returns the height of the EmbeddedWidgetWindow

Returns:

Returns the height of the EmbeddedWidgetWindow

isVisible

public BBjNumber isVisible()

Returns the visiblity of the EmbeddedWidgetWindow

Returns:

Returns the visiblity of the EmbeddedWidgetWindow. 0 = invisible, 1 = visible

getEmbeddedWidgetControl

public EmbeddedWidgetControl getEmbeddedWidgetControl()

Returns the encapsulated EmbeddedWidgetControl

Returns:

Returns the encapsulated EmbeddedWidgetControl

destroy

public void destroy()

Destroys the EmbeddedWidgetWindow

isDestroyed

public BBjNumber isDestroyed()

Returns if the EmbeddedWidgetWindow is destroyed

Returns:

Returns 1 if destroyed, otherwise 0 is returned