new bbbfly.Widget (def, ref, parent)
Parameters
| Name | Type | Description |
|---|---|---|
| def | object | optional Descendant definition |
| ref | object | optional Reference owner |
| parent | object | string | optional Parent DIV element or it's ID |
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| WidgetId | string | null | Widget ID |
| WidgetGroup | string | null | Widget group ID |
| AllowHide | boolean | null | If widget can hide |
| AllowShow | boolean | null | If widget can show |
Extends
- bbbfly.Panel
In Packages
Methods
-
CanForceHide (){boolean}
-
Returns:
Type Description boolean If widget can be force-hidden now -
CanForceShow (){boolean}
-
Returns:
Type Description boolean If widget can be force-shown now -
CanHide (){boolean}
-
- See:
Returns:
Type Description boolean If widget can be hidden now -
CanShow (){boolean}
-
- See:
Returns:
Type Description boolean If widget can be shown now -
ForceHide (){boolean}
-
Forced widget state can be changed only by force methods.
Returns:
Type Description boolean If widget force-hiding was successful -
ForceShow (){boolean}
-
Forced widget state can be changed only by force methods.
Returns:
Type Description boolean If widget force-shownin was successful -
ForceShowOrHide (){boolean}
-
Forced widget state can be changed only by force methods.
- See:
Returns:
Type Description boolean If action was successful -
Hide (){boolean}
-
- See:
-
- CanHide()
- ShowOrHide()
- OnHide
- OnHidden
Returns:
Type Description boolean If widget hiding was successful -
IsShown (){boolean}
-
Returns:
Type Description boolean If widget is shown -
SetForced (forced)
-
Widget will be set force-shown or force-hidden depending on its actual state. Forced widget state can be changed only by force methods.
Parameters:
Name Type Description forced boolean If set widget forced or not forced -
SetWidgetGroup (groupName){boolean}
-
Parameters:
Name Type Description groupName string Group name to be set Returns:
Type Description boolean if group name was set -
Show (){boolean}
-
- See:
-
- CanShow()
- ShowOrHide()
- OnShow
- OnShown
Returns:
Type Description boolean If widget shownin was successful -
ShowOrHide (){boolean}
-
Returns:
Type Description boolean If action was successful
Events
-
OnHidden (force)
-
Parameters:
Name Type Description force boolean If widget was force-hidden - See:
-
- Hide()
- ForceHide()
- OnHide
-
OnHide (force){boolean}
-
Parameters:
Name Type Description force boolean If widget should be force-hidden - See:
-
- Hide()
- ForceHide()
- OnHidden
Returns:
Type Description boolean If widget can hide -
OnShow (force){boolean}
-
Parameters:
Name Type Description force boolean If widget should be force-shown - See:
-
- Show()
- ForceShow()
- OnShown
Returns:
Type Description boolean If widget can show -
OnShown (force)
-
Parameters:
Name Type Description force boolean If widget was force-shown - See:
-
- Show()
- ForceShow()
- OnShow