Bean Methods

Detailed Description

Functions
String	GetCharsetName ()
	Returns the value of the CharsetName property. More...
String	GetDrawingFile ()
	Returns the value of the DrawingFile property. More...
GlgObject	GetDrawingObject ()
	Queries the value of the DrawingObject property. More...
String	GetDrawingURL ()
	Returns the value of the DrawingURL property. More...
GlgObject	GetViewport ()
	Returns the bean's viewport object. More...
boolean	IsReady ()
	Queries the ready state of the bean. More...
boolean	SetAutoUpdateOnInput (boolean update)
	Enabled or disables automatic updates on input events. More...
void	SetCharsetName (String charset_name)
	Sets the CharsetName property. More...
void	SetDrawingFile (String drawing_file)
	Sets the DrawingFile property. More...
boolean	SetDrawingObject (GlgObject drawing_object)
	Sets the DrawingObject property to a GLG object to be used as the bean's viewport. More...
void	SetDrawingURL (String drawing_url)
	Sets the DrawingURL property. More...

Function Documentation

GetCharsetName()

String GetCharsetName

(

)

Returns the value of the CharsetName property.

Returns

Name of the charset used for decoding strings in the loaded drawing.

GetDrawingFile()

String GetDrawingFile

(

)

Returns the value of the DrawingFile property.

Returns

The file used to load the drawing from.

GetDrawingObject()

GlgObject GetDrawingObject

(

)

Queries the value of the DrawingObject property.

Returns

The current value of the DrawingObjectproperty.

GetDrawingURL()

String GetDrawingURL

(

)

Returns the value of the DrawingURL property.

Returns

The URL used to load the drawing from.

GetViewport()

GlgObject GetViewport

(

)

Returns the bean's viewport object.

Returns

The bean's viewport object or null if the drawing hasn't been loaded.

IsReady()

boolean IsReady

(

)

Queries the ready state of the bean.

Returns

true if the bean has finished loading its drawing.

SetAutoUpdateOnInput()

boolean SetAutoUpdateOnInput

(

boolean

update

)

Enabled or disables automatic updates on input events.

Returns the previous setting of automatic updates.

Parameters

update

true to enable automatic updates on input events, false to disable.

Returns

The previous setting of automatic updates.

Automatic updates on input events are enabled by default, but may be disabled to prevent slowing down scrolling and other operations of the real-time charts.

If automatic updates are turned off, input objects redraw themselves on user input event, but an explicit Update call has to be used to redraw any objects constrained to input objects and located outside them. When automatic updates are turned off, the application code also has to explicitly invoke Update for timer events (Format="Timer") to update objects in the drawing with the timer transformations attached.

SetCharsetName()

void SetCharsetName

(

String

charset_name

)

Sets the CharsetName property.

Parameters

charset_name

Name of the charset used for decoding strings in the loaded drawing.

SetDrawingFile()

void SetDrawingFile

(

String

drawing_file

)

Sets the DrawingFile property.

Parameters

drawing_file

The file to load the drawing from.

The drawing must contain a viewport named $Widget, which will be used as the top-level viewport of the bean.

SetDrawingObject()

boolean SetDrawingObject

(

GlgObject

drawing_object

)

Sets the DrawingObject property to a GLG object to be used as the bean's viewport.

The method may be used to replace a drawing displayed in the bean.

Parameters

drawing_object

The drawing object containing a viewport named $Widget, which will be used as the top-level viewport of the bean.

Returns

Success or failure status.

SetDrawingURL()

void SetDrawingURL

(

String

drawing_url

)

Sets the DrawingURL property.

Parameters

drawing_url

The URL to load the drawing from.

The drawing must contain a viewport named $Widget, which will be used as the top-level viewport of the bean.