VBox Methods

VBox Widget has the following methods associated with it:

add

This method is used to add widgets to the box container.

Syntax


add(widgetArray)

Parameters

widgetArray

Comma separated list of widgets.

Return Values

No values are returned.

Exceptions

WidgetError

Remarks

When the widgets are added to the current visible form, then the changes will reflect immediately. Adding a widget to the Box hierarchy, which is already a part of the other widget hierarchy, will lead to undefined behaviors. You have to explicitly remove the widget from one hierarchy before adding it to another Box.

Example


//Defining the properties for a Box properties.
var basicConfBox = {id:"boxAddMethodTest", isVisible:true, 
orientation:constants.BOX_LAYOUT_VERTICAL, skin:"gradroundbox"};

var layoutConfBox = {containerWeight:100};

//Creating the Box.
var boxAddMethodTest = new voltmx.ui.Box(basicConfBox, layoutConfBox, {});

//Adding label ,button widgets to the box.
//Here label and button widgets should be created already and accessible as well.  
boxAddMethodTest.add(lbl,btn);

Platform Availability

Available on all platforms

addAt

This method is used to add widgets to the Box container at the specified index. Widget is prepended if index <0 and appended at the end of the container if the index > size+1. Size is the number of widgets already present in the container. If a new widget is added or removed will reflect immediately from the Box hierarchy model perspective, however the changes are displayed when the Form appears. When the widgets are added to the current visible form, then the changes will reflect immediately. Adding a widget to the Form or Box hierarchy, which is already a part of the other widget hierarchy, will lead to undefined behaviors. You have to explicitly remove the widget from one hierarchy before adding it to another Form or Box.

Syntax


addAt(widgetref,index,animationConfig);

Note: The parameter animationConfig is supported only on iOS (version 5.0 and above) and Android (version 3.0 and above) platforms.

Parameters

boxid

Reference of the name of the widget.

widgetref

Reference of the widget to be added

index

Index number at which the widget is to be added.

animationConfig

Optional. Specifies the animation configuration object. Following are the parameters of the JSObject:

Note: A non dictionary object or passing a null to animationConfig is ignored and will be treated as widget without any animation. Passing an empty dictionary will make the API assume the defaults for each of the supported key in the animation configuration.

animEffect

Optional. Specifies the animation effect. Following are the available options of animation effect:

constants.ANIMATION_EFFECT_EXPand: Specifies the widget must expand gradually by increasing the height of the widget.

constants.ANIMATION_EFFECT_REVEAL: Specifies the widget must appear gradually by decreasing the transparency of the widget.

constants.ANIMATION_EFFECT_NONE: This is the default option. Specifies animation should not be applied to the widget. However the layout animations are applied on the Form. The animation events are not triggered when this option is set.

animDuration

Optional. Specifies the duration of the animation effect in seconds. The default value is 1 second. The negative values are ignored and defaulted to 1 second.

animDelay

Optional. Specifies the delay of the animation effect in seconds. The default value is 0 second. The negative values are ignored and defaulted to 0 second.

animCurve

Optional. Specifies the animation curve to be applied while playing the animation. An animation curve defines the speed of the animations at different intervals of the animation duration. Following are the available options of animation curve:

constants.ANIMATION_CURVE_EASEIN: Specifies the animation effect to start slow in the beginning.

constants.ANIMATION_CURVE_EASEOUT: Specifies the animation effect to slowdown towards the end.

constants.ANIMATION_CURVE_EASEINOUT: Specifies the animation effect to start slow and slowdown towards the end.

constants.ANIMATION_CURVE_LINEAR: This is the default value. Specifies the animation effect to continue with the same speed from start to end.

animCallBacks

Optional. It is a JS dictionary containing the events invoked by the platform during the animation life cycle. Following are the available events:

animStarted: Invoked at the beginning of the animation without any parameters. Following is the signature of the event:
```

  function animStarted()
  ```

animEnded: Invoked at the end of the animation without any parameters. Following is the signature of the event:
```

  function animEnded()
  ```

Note: Passing an invalid type other than the above events lead to run time exceptions/ crashes.

Return Values

None

Exceptions

WidgetError

Example


//Defining animation configuration.
var withAnimConfig=
{  
  "animEffect":constants.ANIMATION_EFFECT_EXPand,   
        "animDuration":1.5, 
        "animDelay":0.4,    
        "animCurve":constants.ANIMATION_CURVE_LINEAR,
        "animCallBacks":{           "animStarted":startCallBackFunc,        "animEnded":endCallBackFunc       }  
}

//Defining the properties for a Box properties.
var basicConfBox = {id:"boxAddAtMethodTest", isVisible:true, orientation:constants.BOX_LAYOUT_VERTICAL, skin:"gradroundbox"};

var layoutConfBox = {containerWeight:100};

//Creating the Box.
var boxAddAtMethodTest = new voltmx.ui.Box(basicConfBox, layoutConfBox, {});

//Adding label to the box at 15th index Position.Here label should be created already and accessible as well.  
boxAddAtMethodTest.addAt(15, withAnimConfig);

Platform Availability

Available on all platforms

Applies an animation to the widget.

Syntax


animate (animationObj, animateConfig, animationCallbacks)

Parameters

animationObj

An animation object created using voltmx.ui.createAnimation function.

animationConfig

As defined in widget level animation section.

animationCallbacks

A JavaScript dictionary that contains key-value pairs. The following keys are supported.

Key	Description
animationEnd	A JavaScript function that is invoked with the animation ends. For more information, see the Remarks section below.
animationStart	A JavaScript function that is invoked with the animation starts. For more information, see the Remarks section below.

Return Values

Returns a platform-specific handle to the animation. This handle currently not used, but is returned for possible future requirements use.

Remarks

The callback for the animationStart key in the JavaScript object passed in this method's animationCallbacks parameter has the following signature.


animationStart(source, animationHandle, elapsedTime);

where source is the widget being animated, animationHandle is the handle returned by the applyAnimation method, and elapsedTime is the amount of time the animation has been running in seconds, when this event is fired..

This event occurs at the start of the animation. If there is 'animation-delay' configured then this event will fire only after the delay period. This event gets called asynchronously.

The callback for the animationEnd key in the JavaScript object passed in this method's animationCallbacks parameter has the following signature.


animationEnd(source, animationHandle, elapsedTime);

where source is the widget being animated, animationHandle is the handle returned by the applyAnimation method, and elapsedTime is the amount of time the animation has been running in seconds, when this event is fired.

This event occurs at the end of the animation. This event gets called asynchronously.

The animate method throws an Invalid Animation Definition Exception if animation definition, does not follow the dictionary structure expected. This method is ignored if it is called on a widget whose immediate parent is not FlexContainer or a FlexScrollContainer.

If the widget is not part of the currently visible view hierarchy, calling this method does nothing. Because this method is asynchronous and immediately returns, it does not wait for the animation to start or complete.

Example

//Sample code of animation
function AnimateBoth() {
    var getFuncName = frm1.listbox18.selectedKey;
    if (getFuncName == "BothLT") {
        frm1.textbox26.animate(myAnimDefinition(),
            animConfiguration(), {});
    } else if (getFuncName == "BothTBL") {
        frm1.textbox26.animate(myAnimDefinitionsc1(),
            animConfiguration(), {});
    }
}

Platform Availability

iOS, Android, Windows, and SPA

remove

This method removes a widget from the Box container. If a new widget is removed will reflect immediately from the Box hierarchy model perspective, however the changes are displayed when the Box appears. When the widgets are added to the current visible Box, then the changes will reflect immediately.

Syntax


remove(widgetref);

Parameters

widgetref

Reference of the widget to be removed.

boxid

Reference of the name of the widget.

Return Values

The current Form handle is returned.

Exceptions

WidgetError

Example


//Defining the properties for a Box properties.
var basicConfBox = {id:"boxRemoveMethodTest", isVisible:true, 
orientation:constants.BOX_LAYOUT_VERTICAL, skin:"gradroundbox"};

var layoutConfBox = {containerWeight:100};

//Creating the Box.
var boxRemoveMethodTest = new voltmx.ui.Box(basicConfBox, layoutConfBox, {});

//Removing label widget from the box .
//Here label should be created already and added inside the box.  
boxRemoveMethodTest.remove(lbl);

Platform Availability

Available on all platforms

removeAt

This method removes a widget at the given index from the Box container. If a new widget is removed will reflect immediately from the Box hierarchy model perspective, however the changes are displayed when the Box appears. When the widgets are added to the current visible Box, then the changes will reflect immediately.

Note: If the index is not within the limits then removeAt will be silent and doesn't yield any result.

Syntax


removeAt(index,animationConfig);

Note: The parameter animationConfig is supported only on iOS (version 5.0 and above) and Android (version 3.0 and above) platforms. It is supported in Volt MX Iris version 5.6 and above only.

Parameters

boxid

Reference of the name of the widget.

index

Index number at which the widget is to be removed.

animationConfig

Optional. Specifies the animation configuration object. Following are the parameters of the JSObject:

Note: A non dictionary object or passing a null to animationConfig is ignored and will be treated as widget without any animation. Passing an empty dictionary will make the API assume the defaults for each of the supported key in the animation configuration.

animEffect

Optional. Specifies the animation effect. Following are the available options of animation effect:

constants.ANIMATION_EFFECT_COLLAPSE: Specifies the widget must collapse gradually by decreasing the height of the widget. This option is applicable only when visibility is turned on.

constants.ANIMATION_EFFECT_FADE: Specifies the widget must disappear gradually by increasing the transparency of the widget.

constants.ANIMATION_EFFECT_NONE: This is the default option. Specifies animation should not be applied to the widget. However the layout animations are applied on the Form. The animation events are not triggered when this option is set.

animDuration

Optional. Specifies the duration of the animation effect in seconds. The default value is 1 second. The negative values are ignored and defaulted to 1 second.

animDelay

Optional. Specifies the delay of the animation effect in seconds. The default value is 0 second. The negative values are ignored and defaulted to 0 second.

animCurve

Optional. Specifies the animation curve to be applied while playing the animation. An animation curve defines the speed of the animations at different intervals of the animation duration. Following are the available options of animation curve:

constants.ANIMATION_CURVE_EASEIN: Specifies the animation effect to start slow in the beginning.

constants.ANIMATION_CURVE_EASEOUT: Specifies the animation effect to slowdown towards the end.

constants.ANIMATION_CURVE_EASEINOUT: Specifies the animation effect to start slow and slowdown towards the end.

constants.ANIMATION_CURVE_LINEAR: This is the default value. Specifies the animation effect to continue with the same speed from start to end.

animCallBacks

Optional. It is a JS dictionary containing the events invoked by the platform during the animation life cycle. Following are the available events:

animStarted: Invoked at the beginning of the animation without any parameters. Following is the signature of the event.
function animStarted()

animEnded: Invoked at the end of the animation without any parameters. Following is the signature of the event.
function animEnded()

Note: Passing an invalid type other than the above events lead to run time exceptions/ crashes.

Return Values

Reference of the name of the widget to be removed.

Exceptions

WidgetError

Example


//Defining animation configuration.
var withAnimConfig1=
{  
  "animEffect":constants.ANIMATION_EFFECT_COLLAPSE, 
        "animDuration":1,   
        "animDelay":0,  
        "animCurve":constants.ANIMATION_CURVE_LINEAR,  

};  


//Defining the properties for a Box properties.
var basicConfBox = {id:"boxRemoveAtMethodTest", isVisible:true, 
orientation:constants.BOX_LAYOUT_VERTICAL, skin:"gradroundbox"};

var layoutConfBox = {containerWeight:100};

//Creating the Box.
var boxRemoveAtMethodTest = new voltmx.ui.Box(basicConfBox, layoutConfBox, {});

//Removing label from the box at 15th index Position. 
//Here label should be created and added at 15th index position of the box.  
boxRemoveAtMethodTest.removeAt(15,withAnimConfig1);

Platform Availability

Available on all platforms

replaceAt

This method replaces a widget with another widget in a VBox. If a widget is replaced from the VBox, will reflect immediately from the VBox hierarchy model perspective; however the changes are displayed when the VBox appears.

Note: Post this operation widget that was replaced will get garbage collected unless you hold explicitly a reference to the replaced widget.

Syntax


replaceAt(widgetref,index,animationConfig);

Parameters

widgetref

Reference of the name of the widget.

index

Specifies the position in number format. Following are the rules applicable for index:

If the index < 0, then first widget in the container gets replaced.

If the index > size -1, then the last widget in the container widget gets replaced. The term size refers to the number of widgets present in the container widget.

animationConfig

Optional. Specifies the animation configuration object. Following are the parameters of the JSObject:

Note: A non dictionary object or passing a null to animationConfig is ignored and will be treated as widget without any animation. Passing an empty dictionary will make the API assume the defaults for each of the supported key in the animation configuration.

animEffect

Specifies the animation effect. Following are the available options of animation effect:

constants.ANIMATION_EFFECT_FLIP_RIGHT: Specifies the widget must flip from right to left.

constants.ANIMATION_EFFECT_FLIP_LEFT: Specifies the widget must flip from left to right.

constants.ANIMATION_EFFECT_NONE: This is the default option. Specifies animation should not be applied to the widget. However the layout animations are applied on the Form. The animation events are not triggered when this option is set.

animDuration

Optional. Specifies the duration of the animation effect in seconds. The default value is 1 second. The negative values are ignored and defaulted to 1 second.

animDelay

Optional. Specifies the delay of the animation effect in seconds. The default value is 0 second. The negative values are ignored and defaulted to 0 second.

animCurve

Optional. Specifies the animation curve to be applied while playing the animation. An animation curve defines the speed of the animations at different intervals of the animation duration. Following are the available options of animation curve:

constants.ANIMATION_CURVE_EASEIN: Specifies the animation effect to start slow in the beginning.

constants.ANIMATION_CURVE_EASEOUT: Specifies the animation effect to slowdown towards the end.

constants.ANIMATION_CURVE_EASEINOUT: Specifies the animation effect to start slow and slowdown towards the end.

constants.ANIMATION_CURVE_LINEAR: This is the default value. Specifies the animation effect to continue with the same speed from start to end.

animCallBacks

Optional. It is a JS dictionary containing the events invoked by the platform during the animation life cycle. Following are the available events:

animStarted: Invoked at the beginning of the animation without any parameters. Following is the signature of the event:
function animStarted()

animEnded: Invoked at the end of the animation without any parameters. Following is the signature of the event:
function animEnded()

Note: Passing an invalid type other than the above events lead to run time exceptions/ crashes.

Return Values

Reference of the name of the widget to be removed.

Exceptions

WidgetError

Example


//Defining animation configuration.
var withAnimConfig2=
{  
  "animEffect":constants.ANIMATION_EFFECT_FLIP_RIGHT,   
        "animDuration":2,   
        "animDelay":3,  
        "animCurve":constants.ANIMATION_CURVE_LINEAR,
        "animCallBacks":{           "animStarted":startCallBackFunc,        "animEnded":endCallBackFunc       }  
};  


//Defining the properties for a Box properties.
var basicConfBox = {id:"boxRemoveAtMethodTest", isVisible:true, 
orientation:constants.BOX_LAYOUT_VERTICAL, skin:"gradroundbox"};

var layoutConfBox = {containerWeight:100};

//Creating the Box.
var boxRemoveAtMethodTest = new voltmx.ui.Box(basicConfBox, layoutConfBox, {});

//Replacing label from the box at 15th index Position.
//Here label should be created and added at 15th index position of the box.  
boxRemoveAtMethodTest.removeAt(newWidget,15,withAnimConfig2);

Platform Availability

iOS
Android

widgets

This method returns an array of the widget references which are direct children of Box.

Syntax


widgets()

Parameters

boxid

Reference of the name of the widget.

Return Values

This method returns Read only array of widget references. Modifying the array and changing the position of widgets in this array doesn't reflect in the Box hierarchy, however you can get handle to the widgets through this array and modify the widgets through widget level methods as exposed by individual widgets.

Exceptions

WidgetError

Example


//Defining the properties for a Box properties.
var wigArr = new Array();  
var basicConfBox = {id:"boxWidgetsMethodTest", isVisible:true, 
orientation:constants.BOX_LAYOUT_VERTICAL, skin:"gradroundbox"};

var layoutConfBox = {containerWeight:100};

//Creating the Box.
var boxWidgetsMethodTest = new voltmx.ui.Box(basicConfBox, layoutConfBox, {});

//Collecting all the widgets of the box into array and displaying the references.  
wigArr = boxWidgetsMethodTest.widgets();
alert("Widgets are::"+wigArr);

Platform Availability

Available on all platforms