AbstractPositionable
On this page
AbstractPositionable ⇐ Abstract
Kind: global abstract class
Extends: Abstract
Properties
| Name | Type | Description |
|---|---|---|
| id | String | The element identifier. |
| $$tag | String | The internal element unique identifier. |
| parent | View | The widget which contains this element. |
| isObservable | boolean | Internal flag always set to true |
| dataEventBus | DataEventBus | A reference on the data event bus singleton. |
| theme | AbstractTheme | The theme of the UI |
| i18n | I18nManager | A reference on the i18n manager. |
| rightToLeft | boolean | If set to true, it will inverse coordinates of the view (in order to be readable from right to left element sides) |
| $$renderingContext | * | Internal renderer element context |
| translateX | number | The translating value of the element on the X-axis (in pixels) which can be animated. |
| translateY | number | The translating value of the element on the Y-axis (in pixels) which can be animated. |
| x | number | The x position (in pixels) |
| y | number | The y position (in pixels) |
| height | number | The height of the view (in pixels) |
| isAuto_height | boolean | Flag which defines if the height field is in auto mode |
| width | number | The width of the view (in pixels) |
| isAuto_width | boolean | Flag which defines if the width field is in auto mode |
| layer | number | The layer the element belongs to (i.e. z-order like in CSS) |
| $$init | boolean | Internal flag to value true when the positionable element is under initialization otherwise set to false when settings have been defined |
- AbstractPositionable ⇐
Abstract
AbstractPositionable()
Class defining the rendering settings for a positionable element.
rendererCreate() ⇒ *
Create the rendering context of the positionable (view/primitive)
Kind: instance method of AbstractPositionable
Returns: * - renderingContext
_getDefaultSettings()
Return the default mapping of settings (for better performance)
Kind: instance method of AbstractPositionable
Access: protected
_defineSettings(defaultSettings) ⇒ Object
Define the mapping of settings used for _rendererCreate
Kind: instance method of AbstractPositionable
Access: protected
| Param | Type | Description |
|---|---|---|
| defaultSettings | Object | default settings initialized |
_rendererCreate(settings) ⇒ *
Method called at the rendering creation.
Kind: instance abstract method of AbstractPositionable
Returns: * - the drawing context or a reference to be able to get it back later
| Param | Type | Description |
|---|---|---|
| settings | Object | The object mapping of settings |
skipTransition(property)
Skip transition on property.
Kind: instance method of AbstractPositionable
| Param | Type | Description |
|---|---|---|
| property | String | A given property on which transition will be skipped |
toggleTransitions(property, value)
Toggle transitions.
Kind: instance method of AbstractPositionable
| Param | Type | Description |
|---|---|---|
| property | String | The property on which the transitions will be done |
| value | boolean | undefined | Flag that should disable or not transitions (true to enable transitions, false to disable transitions) |
setNextTransition(property, settings)
Create transition for only next property change.
Kind: instance method of AbstractPositionable
| Param | Type | Description |
|---|---|---|
| property | String | The property on which the transition will be applied |
| settings | Object | Various fields |
_computeRTL_x(x) ⇒ number
Compute the new x position in a “right to left” context
Kind: instance method of AbstractPositionable
Returns: number - The rendering value
| Param | Type | Description |
|---|---|---|
| x | number | The value to compute |
_updateXFromWidth(rc)
In RTL (right to left) mode, a position depends on its parent width. If parent’s width is changing then all children positions must be updated
Kind: instance method of AbstractPositionable
| Param | Type |
|---|---|
| rc | * |