Home | Class Index

SDK Version: 3.11.4-302512

Documentation generated on 24 July 2015

Class
caplin.popout

PopoutService

Service to be used inside a popout window to enable communication with its associated caplin.popout.Popout from the application's main window. Any events raised by the associated caplin.popout.Popout will also be raised by this service. This service can be accessed from the caplin.core.ServiceRegistry using the alias "caplin.popout-service". This service should only be referenced in windows opened using caplin.popout.Popout. Such windows are required to reference this service.

Constructor Summary

Attributes Name and Description
caplin.popout.PopoutService( windowObject)

Method Summary

Attributes Name and Description
void fireEvent(string name, Object properties)

Fires the given event on this service and on the Popout associated with this popout window.
map getProperties()

Gets a map of all properties set on the Popout associated with this popout window.
var getProperty(String propertyName)

Gets the value for a given property set on the Popout associated with this popout window.
Object getWindowGeometrics()

Returns the current position and dimensions of this popout window.
void resizeWindow(int width, int height)

Resizes this popout window to the given dimensions.
void setProperties(Object properties)

Sets properties on the Popout associated with this popout window.

Constructor Detail

► caplin.popout.PopoutService( windowObject)

Parameters
windowObject

Method Detail

► void fireEvent(string name, Object properties)

Fires the given event on this service and on the Popout associated with this popout window.

Parameters
string name The name of the event.
Object properties A map of properties to be passed along with the event

► map getProperties()

Gets a map of all properties set on the Popout associated with this popout window.

Returns
{map} The map of properties.

► var getProperty(String propertyName)

Gets the value for a given property set on the Popout associated with this popout window.

Parameters
String propertyName The name of the property to get.
Returns
{var} The value of the property.

► Object getWindowGeometrics()

Returns the current position and dimensions of this popout window.

Returns
{Object} Contains geometric properties with integer values. Included properties are: 'width', 'height', 'left' and 'top'.

► void resizeWindow(int width, int height)

Resizes this popout window to the given dimensions.

Parameters
int width The desired width of the popout window.
int height The desired height of the popout window.

► void setProperties(Object properties)

Sets properties on the Popout associated with this popout window.

Parameters
Object properties The map of properties to set.