Phone API Reference - UI Classes (Widgets) - Group

Desk Phone API features described in this section are deprecated and supported only on the following models: D40, d45, d50, d60, d62, d65, d70

Widget that contains other widgets and acts as a container. For example, this widget is useful for showing and hiding many widgets at one time. Groups can have any number of widgets attached to them; e.g., Group widgets, Text widgets, and Input widgets.

There are certain Group widgets that are automatically instantiated for an app and must be used for displaying anything. The  window  property is always accessible to an app and is shown when the app is foregrounded. The property  digium.app.idleWindow  is instantiated based on the app's app.json manifest. 

 

Class Constructor

new Group()

Constructs a new Group Object. A Group acts as a container for other widgets.

var groupObj = new Group(x, y, width, height);

 

Initialization Parameters

Name

Required

Type

Default

Description

Name

Required

Type

Default

Description

x

Yes

integer

 

x coordinate value for top left corner.

y

Yes

integer

 

y coordinate value for top left corner.

width

Yes

integer

 

Width in pixels.

height

Yes

integer

 

Height in pixels.

This Class inherits methods and properties from the Widget Base Class. See  Widget Base Class  for more information about setting your Object's x, y, w, and h properties or adding children to it.

 

Methods

Name 

Description 

Name 

Description 

add

Adds one or more widgets to the group.

clear

Removes all child elements from the group or removes all content from the list.

remove

Removes one or more widgets from a group.

 

Return to Documentation Home I Return to Sangoma Support