new ScrubBar(idopt, initialValueopt, smallIncrementopt, largeIncrementopt, largeIncrementAfteropt)
The ScrubBar provides a media scrub bar showing current position and portion of the stream that is currently buffered.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
String |
<optional> |
The unique ID of the widget. If excluded, a temporary internal ID will be used (but not included in any output). |
initialValue |
double |
<optional> |
Initial value for the slider. |
smallIncrement |
double |
<optional> |
Amount to increase/decrease the value by when VK_LEFT or VK_RIGHT is pressed. |
largeIncrement |
double |
<optional> |
Amount to increase/decrease the value by when VK_LEFT or VK_RIGHT is held down. |
largeIncrementAfter |
double |
<optional> |
Number of smallIncrements to perform until switching to largeIncrement when key is held down. |
- Source:
Extends
Methods
addClass(className)
Adds a CSS class to the widget if not already present.
Parameters:
| Name | Type | Description |
|---|---|---|
className |
String | The class name to add. |
- Inherited From:
- Source:
addEventListener(ev, func)
Add an event listener function to this widget.
Parameters:
| Name | Type | Description |
|---|---|---|
ev |
String | The event type to listen for (e.g. keydown) |
func |
function | The handler to be called when the event is fired. |
- Inherited From:
- Source:
- See:
appendChildWidget(widget)
Appends a child widget to this widget.
Parameters:
| Name | Type | Description |
|---|---|---|
widget |
antie.widgets.Widget | The child widget to add. |
- Inherited From:
- Source:
broadcastEvent()
Broadcasts an event from the application level to every single
object it contains.
- Inherited From:
- Source:
bubbleEvent(ev)
Bubbles an event from object, triggering any event listeners bound to this widget and any
parent widgets.
To halt bubbling of the event, see antie.events.Event#stopPropagation.
Parameters:
| Name | Type | Description |
|---|---|---|
ev |
antie.events.Event | The event to bubble. |
- Inherited From:
- Source:
- See:
fireEvent(ev)
Fires an event on this object, triggering any event listeners bound to this widget only.
Note: this does not bubble or propagate the event to other widgets, for that functionality
see #bubbleEvent.
Parameters:
| Name | Type | Description |
|---|---|---|
ev |
antie.events.Event | The event to fire. |
- Inherited From:
- Source:
- See:
focus()
Moves focus to a button within this container. Focused button will be that which follows
the current 'active' path.
- Inherited From:
- Source:
Returns:
Boolean true if focus has been moved to a button. Otherwise returns false.
getActiveChildWidget()
Get the current active widget.
- Inherited From:
- Source:
Returns:
The current active widget
getChildWidget(id)
Get a child widget from its unique ID.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | The id of the child widget to return. |
- Inherited From:
- Source:
Returns:
antie.widgets.Widget of the widget with the given ID, otherwise undefined if the child does not exist.
getChildWidgetCount()
Gets the number of direct child widgets.
- Inherited From:
- Source:
Returns:
The number of direct child widgets.
getChildWidgets()
Get an array of all this widget's children.
- Inherited From:
- Source:
Returns:
An array of all this widget's children.
getClasses()
Get an array of class names that this widget has.
- Inherited From:
- Source:
Returns:
An array of class names (Strings)
getComponent()
Returns the component this widget is a descendant of
- Inherited From:
- Source:
getCurrentApplication()
Gets a reference to the application responsible for creating the widget.
- Inherited From:
- Source:
- See:
-
- antie.RuntimeContext
getDataItem()
Get any data item associated with this widget.
- Inherited From:
- Source:
getValue()
Returns the current value shown by the progress indicator.
- Inherited From:
- Source:
hasChildWidget(id)
Checks to see if a specific widget is a direct child of this widget.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
String | The widget id of the widget to check to see if it is a direct child of this widget. |
- Inherited From:
- Source:
hasClass(className)
Checks to see if the widget has a given CSS class.
Parameters:
| Name | Type | Description |
|---|---|---|
className |
String | The class name to check. |
- Inherited From:
- Source:
Returns:
Boolean true if the device has the className. Otherwise boolean false.
hide(options)
Hides a widget. If animation is enabled the widget will be faded out of view.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Details of the element to be shown, with optional parameters.
Properties
|
- Inherited From:
- Source:
Returns:
Boolean true if animation was called, otherwise false
insertChildWidget(index, widget)
Inserts a child widget at the specified index.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
Integer | The index where to insert the child widget. |
widget |
antie.widgets.Widget | The child widget to add. |
- Inherited From:
- Source:
isComponent() → {Boolean}
Returns whether the widget is a Component.
- Inherited From:
- Source:
Returns:
True if the widget is a Component.
- Type
- Boolean
isFocusable()
Checks to see if a widget is focussable, i.e. contains an enabled button.
- Inherited From:
- Source:
- See:
isFocussed()
Get if this widget is in the current focus path.
- Inherited From:
- Source:
Returns:
Boolean true if this widget is in the focus path, otherwise false.
moveTo(options)
Moves a widget so that its top-left corner is at the given position.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Details of the element to be shown, with optional parameters.
Properties
|
- Inherited From:
- Source:
Returns:
Boolean true if animation was called, otherwise false
prependWidget(widget)
Inserts a widget before the current one.
Parameters:
| Name | Type | Description |
|---|---|---|
widget |
antie.widgets.Widget | The child widget to add. |
- Inherited From:
- Source:
removeChildWidget(widget, retainElementopt)
Removes a specific child widget from this widget.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
widget |
antie.widgets.Widget | The child widget to remove. | |
retainElement |
Boolean |
<optional> |
Pass true to retain the child output element of the given widget |
- Inherited From:
- Source:
removeChildWidgets()
Remove all child widgets from this widget.
- Inherited From:
- Source:
removeClass(className)
Removes a CSS class from the widget if present.
Parameters:
| Name | Type | Description |
|---|---|---|
className |
String | The class name to remove. |
- Inherited From:
- Source:
removeEventListener(ev, func)
Removes an event listener function to this widget.
Parameters:
| Name | Type | Description |
|---|---|---|
ev |
String | The event type that the listener is to be removed from (e.g. keydown) |
func |
function | The handler to be removed. |
- Inherited From:
- Source:
- See:
removeFocus()
Remove focus state from this widget.
- Inherited From:
- Source:
render(device)
Renders the widget and any child widgets to device-specific output.
Parameters:
| Name | Type | Description |
|---|---|---|
device |
antie.devices.Device | The device to render to. |
- Overrides:
- Source:
Returns:
A device-specific object that represents the widget as displayed on the device (in a browser, a DOMElement);
setActiveChildIndex(index)
Attempts to set focus to the child widget at the given index.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
Integer | Index of the child widget to set focus to. |
- Inherited From:
- Source:
- See:
Returns:
Boolean true if the child widget was focusable, otherwise boolean false.
setActiveChildWidget(widget)
Attempt to set focus to the given child widget.
Note: You can only set focus to a focusable widget. A focusable widget is one that
contains an enabled antie.widgets.Button as either a direct or indirect child.
Note: Widgets have 2 independent states: active and focussed. A focussed widget is
either the Button with focus, or any parent of that Button. An active widget is
one which is the active child of its parent Container. When the parent widget
receives focus, focus will be placed on the active child.
Classes 'active' and 'focus' are appended to widgets with these states.
Parameters:
| Name | Type | Description |
|---|---|---|
widget |
antie.widgets.Widget | The child widget to set focus to. |
- Inherited From:
- Source:
Returns:
Boolean true if the child widget was focusable, otherwise boolean false.
setDataItem(dataItem)
Associate a data item with this widget.
Parameters:
| Name | Type | Description |
|---|---|---|
dataItem |
object | Object to associate with this widget. |
- Inherited From:
- Source:
setSmallIncrement(val)
Sets the small increment
Parameters:
| Name | Type | Description |
|---|---|---|
val |
Float | The increment value (between 0.0 and 1.0 inclusive). |
- Inherited From:
- Source:
setValue(val)
Sets the current value to be shown by the progress indicator.
Parameters:
| Name | Type | Description |
|---|---|---|
val |
Float | The value to show (between 0.0 and 1.0 inclusive). |
- Inherited From:
- Source:
show(options)
Shows a widget. If animation is enabled the widget will be faded in.
Parameters:
| Name | Type | Description | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | Details of the element to be shown, with optional parameters.
Properties
|
- Inherited From:
- Source:
Returns:
Boolean true if animation was called, otherwise false