Home | Class Index

SDK Version: 3.6.2-275863

Documentation generated on 28 October 2013

Interface
caplin.services.workspace

Workspace

The class is still an Alpha release. It should only be used for experimental development as substantial changes may occur.
A workspace is an area of an application's GUI which a user can customise by adding, removing and/or moving caplin.component.Components. This interface allows you to manage a workspace's lifecycle, view its properties, and insert components into it.

Constructor Summary

Attributes Name and Description
caplin.services.workspace.Workspace()

Method Summary

Attributes Name and Description
String getName()

Returns the name of the workspace.
String getProperty(String propertyName)

Returns the value of the workspace's property.
void insertComponent(caplin.component.Component component)

Inserts the given component into the workspace.
void setName(String name)

Sets the name of the workspace.
void setProperty(String propertyName, Variant propertyValue)

Sets the value of the workspace's property.

Constructor Detail

► caplin.services.workspace.Workspace()

Method Detail

► String getName()

Returns the name of the workspace. This is a display name only, and should not be used for identification.

Returns
{String} The name of the workspace.

► String getProperty(String propertyName)

Returns the value of the workspace's property.

Parameters
String propertyName The name of the property to retrieve.
Returns
{String}

► void insertComponent(caplin.component.Component component)

Inserts the given component into the workspace.

Parameters
caplin.component.Component component The component to be added to the workspace.

► void setName(String name)

Sets the name of the workspace.

Parameters
String name The new name.

► void setProperty(String propertyName, Variant propertyValue)

Sets the value of the workspace's property.

Parameters
String propertyName The name of the property to be set.
Variant propertyValue The value of the property to be set.