MODULES Uize.Widget.Scrolly
- Contents
- 1. Introduction
- 2. DOM Nodes
- 3. Instance Properties
- 4. Child Widgets
-
5. State Properties
- 5.1. built
- 5.2. busy
- 5.3. busyInherited
- 5.4. busyParentTickle
- 5.5. children
- 5.6. container
- 5.7. enabled
- 5.8. enabledInherited
- 5.9. enabledParentTickle
- 5.10. html
- 5.11. idPrefix
- 5.12. idPrefixConstruction
- 5.13. insertionMode
- 5.14. isScrollableX
- 5.15. isScrollableY
- 5.16. localized
- 5.17. maxPageX
- 5.18. maxPageY
- 5.19. name
- 5.20. nodeMap
- 5.21. pageX
- 5.22. pageY
- 5.23. parent
- 5.24. showButtonsWhenNotScrollable
- 5.25. wired
-
6. Instance Methods
- 6.1. addChild
- 6.2. addChildren
- 6.3. ajax
- 6.4. buildHtml
- 6.5. callInherited
- 6.6. childHtml
- 6.7. childId
- 6.8. confirm
- 6.9. displayNode
- 6.10. fire
- 6.11. flushNodeCache
- 6.12. get
- 6.13. getContainer
- 6.14. getHtml
- 6.15. getInherited
- 6.16. getNode
- 6.17. getNodeStyle
- 6.18. getNodeValue
- 6.19. getProvider
- 6.20. globalizeNode
- 6.21. inform
- 6.22. injectNodeHtml
- 6.23. insertOrWireUi
- 6.24. insertUi
- 6.25. is
- 6.26. isMet
- 6.27. kill
- 6.28. localize
- 6.29. met
- 6.30. nodeId
- 6.31. onChange
- 6.32. once
- 6.33. removeChild
- 6.34. removeNode
- 6.35. removeUi
- 6.36. set
- 6.37. setInherited
- 6.38. setNodeClipRect
- 6.39. setNodeInnerHtml
- 6.40. setNodeOpacity
- 6.41. setNodeProperties
- 6.42. setNodeStyle
- 6.43. setNodeValue
- 6.44. showNode
- 6.45. toggle
- 6.46. unmet
- 6.47. unwire
- 6.48. unwireNode
- 6.49. unwireNodeEventsByMatch
- 6.50. unwireUi
- 6.51. updateUi
- 6.52. valueOf
- 6.53. whenever
- 6.54. wire
- 6.55. wireNode
- 6.56. wireUi
-
7. Static Methods
- 7.1. Uize.Widget.Scrolly.alphastructor
- 7.2. Uize.Widget.Scrolly.declare
- 7.3. Uize.Widget.Scrolly.doMy
- 7.4. Uize.Widget.Scrolly.dualContextMethods
- 7.5. Uize.Widget.Scrolly.dualContextProperties
- 7.6. Uize.Widget.Scrolly.fire
- 7.7. Uize.Widget.Scrolly.get
- 7.8. Uize.Widget.Scrolly.getBlankImageUrl
- 7.9. Uize.Widget.Scrolly.instanceMethods
- 7.10. Uize.Widget.Scrolly.instanceProperties
- 7.11. Uize.Widget.Scrolly.mixins
- 7.12. Uize.Widget.Scrolly.omegastructor
- 7.13. Uize.Widget.Scrolly.set
- 7.14. Uize.Widget.Scrolly.singleton
- 7.15. Uize.Widget.Scrolly.spawn
- 7.16. Uize.Widget.Scrolly.stateProperties
- 7.17. Uize.Widget.Scrolly.staticMethods
- 7.18. Uize.Widget.Scrolly.staticProperties
- 7.19. Uize.Widget.Scrolly.subclass
- 7.20. Uize.Widget.Scrolly.toggle
- 7.21. Uize.Widget.Scrolly.treeInheritedStateProperties
- 7.22. Uize.Widget.Scrolly.unwire
- 7.23. Uize.Widget.Scrolly.wire
- 8. Static Properties
1. Introduction
The Uize.Widget.Scrolly
class provides animated scrolling for the contents of a view port, with support for both horizontal and vertical scrolling.
DEVELOPERS: Chris van Rensburg, Jan Borgersen, original code contributed by Zazzle Inc.
1.1. In a Nutshell
The Uize.Widget.Scrolly
class is essentially just a scroller for a node.
It supports horizontal scrolling, vertical scrolling, or both horiztonal and vertical scrolling together in the same instance. User interface and programmatic means are provided for controlling the scroll position of an instance.
1.1.1. Scrolling in Pages
Scroll position is expressed in pages, where one horizontal page is defined as the width of the view
DOM node, and one vertical page is defined as the height of the view
DOM node.
A scrolly is scrollable horizontally if the value of its scrollWidth
style property is greater than the value of its offsetWidth
style property. Similarly, a scrolly is scrollable vertically if the value of its scrollHeight
style property is greater than the value of its offsetHeight
style property.
1.1.2. How Scrolling is Performed
Scrolling is achieved by setting the values of the scrollLeft
and scrollTop
properties of the view
DOM node.
1.1.2.1. Animation
Whenever the values of either the pageX
or pageY
state properties are modified, a fade is initiated in order to animate the scroll position of the view
DOM node from its current position to the new position represented by the new pageX
and pageY
values.
The scrolly instance creates an instance of the Uize.Fade
class in order to drive the scroll position fade. This fade instance is accessible through the fade
instance property, so the properties of the scroll fade can be configured by setting values for the various state properties of this fade
instance, such as its curve
, duration
, and other state properties.
If the value of the pageX
or pageY
state properties are modified in the middle of a scroll fade - either by scrolling with buttons or by scrolling programmatically - then the current animation will be stopped and a new animation will be started to fade the scroll position from its current position to the new scroll position.
1.1.3. Scrolling With Buttons
Instances of the Uize.Widget.Scrolly
class are equipped with four scroll buttons: left
and right
buttons for scrolling horizontally, and up
and down
buttons for scrolling vertically.
Providing markup for the buttons is optional, and one can provide button HTML for only horizontal scrolling, only vertical scrolling, or both horiztonal and vertical scrolling. If one doesn't provide markup for any of the scroll buttons, there is still the option of scrolling programmatically.
1.1.3.1. Shift-click
Clicking the buttons scrolls one page at a time (see Scrolling in Pages), but holding down the shift modifier key when clicking on the buttons will scroll all the way to the extremes.
Holding down shift while clicking on the left
button will scroll to the far left (first page, horizontally), effectively setting pageX
to 0
. Holding down shift while clicking on the right
button will scroll to the far right (last page, horizontally), effectively setting pageX
to the value of maxPageX
. Holding down shift while clicking on the up
button will scroll to the top (first page, vertically), effectively setting pageY
to 0
. Holding down shift while clicking on the down
button will scroll to the bottom (last page, vertically), effectively setting pageX
to the value of maxPageX
.
1.1.4. Scrolling Programmatically
In addition to scrolling with buttons, it is also possible to programmatically scroll an instance by setting the values of its pageX
and pageY
state properties.
EXAMPLES
// scroll horizontally scrolly.set ({pageX:scrolly.get ('pageX') - 1}); // scroll one page left scrolly.set ({pageX:scrolly.get ('pageX') + 1}); // scroll one page right scrolly.set ({pageX:0}); // scroll to first page, horizontally scrolly.set ({pageX:Infinity}); // scroll to last page, horizontally // scroll vertically scrolly.set ({pageY:scrolly.get ('pageY') - 1}); // scroll one page up scrolly.set ({pageY:scrolly.get ('pageY') + 1}); // scroll one page down scrolly.set ({pageY:0}); // scroll to first page, vertically scrolly.set ({pageY:Infinity}); // scroll to last page, vertically
When scrolling left or right by incrementing or decrementing the value of the pageX
state property, and when scrolling up or down by incrementing or decrementing the value of the pageY
state property, it is not necessary to worry about detecting the first and last page boundaries, since a conformer for the pageX
and pageY
state properties takes care of this for you and makes sure that the values are always within bounds. This is why it is also possible to scroll to the last page by specifying the value Infinity
, since this value will be constrained to the value of maxPageX
when setting pageX
and the value of maxPageY
when setting pageY
.
1.1.5. State Summary
For the convenience of application code, a full complement of read-only state properties provides a state summary for scrolly instances.
This state summary is provided through the isScrollableX
and isScrollableY
boolean read-only properties, and the maxPageX
, and maxPageY
integer read-only properties. These various state properties can be used in the implementation of subclasses, in other widget classes that use the Uize.Widget.Scrolly
class, or in application code that uses scrollies.
1.1.6. The HTML
The following example HTML shows a typical way that the HTML markup for an instance could be implemented.
EXAMPLE HTML
<div class="scrollyHorz"> <a id="page_myScrolly_left" href="javascript://" class="scrollyButtonLeft"></a> <div id="page_myScrolly-view" class="scrollyView"> <!-- THE SCROLLABLE STUFF GOES HERE --> </div> <a id="page_myScrolly_right" href="javascript://" class="scrollyButtonRight"></a> </div>
The above example HTML is for a scrolly instance that is attached as the child widget named "myScrolly" to the page widget instance with the idPrefix
of 'page'
. Therefore, the idPrefix
of the left
child widget is 'page_myScrolly_left'
, and the idPrefix
of the scrolly's view
DOM node is 'page_myScrolly-view'
.
1.2. Examples
The following example pages are good showcases for the Uize.Widget.Scrolly
module...
Scrolly - See the scrolly widget in action, as it scrolls two sets of thumbnails - horizontal and vertical - with an accompanying JavaScript animation effect. | |
Scrolly Carousel - See the scrolly widget being used to create a scrollable carousel, where scrolling through the pages is accompanied by a JavaScript animation effect. |
SEARCH FOR EXAMPLES
Use the link below to search for example pages on the UIZE Web site that reference the Uize.Widget.Scrolly
module...
SEARCH
1.3. Implementation Info
The Uize.Widget.Scrolly
module defines the Uize.Widget.Scrolly
class, which is a subclass of Uize.Widget
.
INHERITANCE CHAIN
Uize.Class
−> Uize.Widget
−> Uize.Widget.Scrolly
1.3.1. Features Introduced in This Module
The features listed in this section have been introduced in this module.
STATE PROPERTIES
isScrollableX
| isScrollableY
| maxPageX
| maxPageY
| pageX
| pageY
| showButtonsWhenNotScrollable
1.3.2. Features Overridden in This Module
The features listed in this section have been overridden in this module.
The module that an overridden feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.
INSTANCE METHODS
STATIC PROPERTIES
Uize.Widget.Scrolly.moduleName
| Uize.Widget.Scrolly.nonInheritableStatics
| Uize.Widget.Scrolly.undefined
1.3.3. Features Inherited From Other Modules
The features listed in this section have been inherited from other modules.
The module that an inherited feature was initially introduced in will be noted in the IMPLEMENTATION INFO notes for the feature.
INSTANCE METHODS
addChild
| addChildren
| ajax
| buildHtml
| callInherited
| childHtml
| childId
| confirm
| displayNode
| fire
| flushNodeCache
| get
| getContainer
| getHtml
| getInherited
| getNode
| getNodeStyle
| getNodeValue
| getProvider
| globalizeNode
| inform
| injectNodeHtml
| insertOrWireUi
| insertUi
| is
| isMet
| kill
| localize
| met
| nodeId
| onChange
| once
| removeChild
| removeNode
| removeUi
| set
| setInherited
| setNodeClipRect
| setNodeInnerHtml
| setNodeOpacity
| setNodeProperties
| setNodeStyle
| setNodeValue
| showNode
| toggle
| unmet
| unwire
| unwireNode
| unwireNodeEventsByMatch
| unwireUi
| whenever
| wire
| wireNode
| wireUi
INSTANCE PROPERTIES
STATE PROPERTIES
built
| busy
| busyInherited
| busyParentTickle
| children
| container
| enabled
| enabledInherited
| enabledParentTickle
| html
| idPrefix
| idPrefixConstruction
| insertionMode
| localized
| name
| nodeMap
| parent
| wired
STATIC METHODS
Uize.Widget.Scrolly.alphastructor
| Uize.Widget.Scrolly.declare
| Uize.Widget.Scrolly.doMy
| Uize.Widget.Scrolly.dualContextMethods
| Uize.Widget.Scrolly.dualContextProperties
| Uize.Widget.Scrolly.fire
| Uize.Widget.Scrolly.get
| Uize.Widget.Scrolly.getBlankImageUrl
| Uize.Widget.Scrolly.instanceMethods
| Uize.Widget.Scrolly.instanceProperties
| Uize.Widget.Scrolly.mixins
| Uize.Widget.Scrolly.omegastructor
| Uize.Widget.Scrolly.set
| Uize.Widget.Scrolly.singleton
| Uize.Widget.Scrolly.spawn
| Uize.Widget.Scrolly.stateProperties
| Uize.Widget.Scrolly.staticMethods
| Uize.Widget.Scrolly.staticProperties
| Uize.Widget.Scrolly.subclass
| Uize.Widget.Scrolly.toggle
| Uize.Widget.Scrolly.treeInheritedStateProperties
| Uize.Widget.Scrolly.unwire
| Uize.Widget.Scrolly.wire
STATIC PROPERTIES
Uize.Widget.Scrolly.busyParentTickle
| Uize.Widget.Scrolly.enabledParentTickle
| Uize.Widget.Scrolly.isWired
| Uize.Widget.Scrolly.pathToResources
1.3.4. Modules Directly Under This Namespace
There are no modules directly under this namespace.
1.3.5. Unit Tests
There is no dedicated unit tests module for the Uize.Widget.Scrolly
module.
2. DOM Nodes
2.1. view
A node of any type, whose scrollLeft
and scrollTop
style properties are maintained by the Uize.Widget.Scrolly
class as the values of the pageX
and pageY
state properties are modified.
The overflow
CSS style property for this node should be set to hidden
, either in an inline style
attribute, an inline stylesheet, or an external stylesheet.
3. Instance Properties
3.1. fade
An instance of the Uize.Fade
class that is used to animate the scrolling of the contents of the view
DOM node.
The fade
instance is created during the construction of the Uize.Widget.Scrolly
instance, so the fade properties can be modified immediately after the scrolly is created. The behavior of the animation can be controlled by setting values for the various state properties of the fade
instance, such as its curve
, duration
, and other state properties.
EXAMPLE
page.addChild ('myScrolly',Uize.Widget.Scrolly).fade.set ({duration:1000});
In the above example, an instance of the Uize.Widget.Scrolly
class is added as a child widget of a page widget instance, and then its fade duration is set to 1000
(i.e. one second). Because the addChild
instance method returns a reference to the child widget being added, and because the fade
instance is created during construction of the Uize.Widget.Scrolly
instance, the set
instance method can be called in a chained fashion.
3.2. showConfirm
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
3.3. showInform
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
4. Child Widgets
4.1. down
An instance of the Uize.Widget.Button
class, that is wired up so that clicking on it will scroll the view
DOM node down by one page.
Clicking this button has the effect of incrementing the value of the pageY
state property. The markup for this button is optional. The enabled state of this button is managed by the Uize.Widget.Scrolly
class, so that it is disabled whenever it is not possible to scroll down, such as when the view
DOM node is already scrolled all the way to the bottom (i.e. the value of pageY
is equal to the value of maxPageY
).
NOTES
see the related pageY state property |
|
see the companion up child widget, and the related left and right child widgets |
4.2. left
An instance of the Uize.Widget.Button
class, that is wired up so that clicking on it will scroll the view
DOM node left by one page.
Clicking this button has the effect of decrementing the value of the pageX
state property. The markup for this button is optional. The enabled state of this button is managed by the Uize.Widget.Scrolly
class, so that it is disabled whenever it is not possible to scroll left, such as when the view
DOM node is already scrolled all the way to the left (i.e. the value of pageX
is 0
).
NOTES
see the related pageX state property |
|
see the companion right child widget, and the related up and down child widgets |
4.3. right
An instance of the Uize.Widget.Button
class, that is wired up so that clicking on it will scroll the view
DOM node right by one page.
Clicking this button has the effect of incrementing the value of the pageX
state property. The markup for this button is optional. The enabled state of this button is managed by the Uize.Widget.Scrolly
class, so that it is disabled whenever it is not possible to scroll right, such as when the view
DOM node is already scrolled all the way to the right (i.e. the value of pageX
is equal to the value of maxPageX
).
NOTES
see the related pageX state property |
|
see the companion left child widget, and the related up and down child widgets |
4.4. up
An instance of the Uize.Widget.Button
class, that is wired up so that clicking on it will scroll the view
DOM node up by one page.
Clicking this button has the effect of decrementing the value of the pageY
state property. The markup for this button is optional. The enabled state of this button is managed by the Uize.Widget.Scrolly
class, so that it is disabled whenever it is not possible to scroll up, such as when the view
DOM node is already scrolled all the way to the top (i.e. the value of pageY
is 0
).
NOTES
see the related pageY state property |
|
see the companion down child widget, and the related left and right child widgets |
5. State Properties
5.1. built
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.2. busy
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.3. busyInherited
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.4. busyParentTickle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.5. children
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.6. container
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.7. enabled
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.8. enabledInherited
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.9. enabledParentTickle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.10. html
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.11. idPrefix
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.12. idPrefixConstruction
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.13. insertionMode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.14. isScrollableX
A read-only boolean (whose value is managed by the Uize.Widget.Scrolly
class), indicating whether or not the contents of the view
DOM node is wide enough to make it horizontally scrollable.
NOTES
this property is read-only | |
see the companion isScrollableY state property |
|
the initial value is false , and it is updated each time the value of maxPageX changes |
IMPLEMENTATION INFO
this feature was introduced in this module |
5.15. isScrollableY
A read-only boolean (whose value is managed by the Uize.Widget.Scrolly
class), indicating whether or not the contents of the view
DOM node is tall enough to make it vertically scrollable.
NOTES
this property is read-only | |
see the companion isScrollableX state property |
|
the initial value is false , and it is updated each time the value of maxPageY changes |
IMPLEMENTATION INFO
this feature was introduced in this module |
5.16. localized
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.17. maxPageX
A read-only integer (whose value is managed by the Uize.Widget.Scrolly
class), indicating the maximum possible value for the pageX
state property.
The value of this property can be used as an indication of the number of horizontal pages for the contents of the view
DOM node. For example, a value of 0
indicates that there is only one page horizontally (i.e. the maximum value for pageX
is 0
). A value of 5
, on the other hand, indicates that there are six pages horizontally, where those six pages are represented by the values 0
through 5
for the pageX
state property.
NOTES
this property is read-only | |
the initial value is undefined , and it is later updated upon wiring the instance's UI, every time the updateUi instance method is called, and every time a value is set for the pageX state property |
|
see the companion maxPageY state property |
IMPLEMENTATION INFO
this feature was introduced in this module |
5.18. maxPageY
A read-only integer (whose value is managed by the Uize.Widget.Scrolly
class), indicating the maximum possible value for the pageY
state property.
The value of this property can be used as an indication of the number of vertical pages for the contents of the view
DOM node. For example, a value of 0
indicates that there is only one page vertically (i.e. the maximum value for pageY
is 0
). A value of 5
, on the other hand, indicates that there are six pages vertically, where those six pages are represented by the values 0
through 5
for the pageY
state property.
NOTES
this property is read-only | |
the initial value is undefined , and it is later updated upon wiring the instance's UI, every time the updateUi instance method is called, and every time a value is set for the pageY state property |
|
see the companion maxPageX state property |
IMPLEMENTATION INFO
this feature was introduced in this module |
5.19. name
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.20. nodeMap
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.21. pageX
An integer, representing the current horizontal scroll position of the view
DOM node as a page number (see Scrolling in Pages) in the X-axis.
5.21.1. Conformed
When setting the value for this property, the value is conformed in a number of ways.
1. | The value will be coerced to a number type by invoking the valueOf Intrinsic Method . This means that one can specify a string value that is a valid formatted number, or an object (such as an instance of a Uize.Class subclass) that implements the value interface. |
2. | Values that cannot be successfully coerced to a number type (such as null , NaN , etc.) will result in the property not changing its value. |
3. | The value will be constrained so that it cannot go below 0 and cannot go above the value of the maxPageX state property. |
NOTES
see the companion pageY state property |
|
the initial value is 0 |
IMPLEMENTATION INFO
this feature was introduced in this module |
5.22. pageY
An integer, representing the current vertical scroll position of the view
DOM node as a page number (see Scrolling in Pages) in the Y-axis.
5.22.1. Conformed
When setting the value for this property, the value is conformed in a number of ways.
1. | The value will be coerced to a number type by invoking the valueOf Intrinsic Method . This means that one can specify a string value that is a valid formatted number, or an object (such as an instance of a Uize.Class subclass) that implements the value interface. |
2. | Values that cannot be successfully coerced to a number type (such as null , NaN , etc.) will result in the property not changing its value. |
3. | The value will be constrained so that it cannot go below 0 and cannot go above the value of the maxPageY state property. |
NOTES
see the companion pageX state property |
|
the initial value is 0 |
IMPLEMENTATION INFO
this feature was introduced in this module |
5.23. parent
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
5.24. showButtonsWhenNotScrollable
A boolean, specifying whether or not the scroll buttons should be displayed in a given axis when it is not possible to scroll in that axis.
When showButtonsWhenNotScrollable
is set to false
, the scroll buttons for a given axis will be hidden when it is not possible to scroll in that axis. If it is possible to scroll in the axis, then the buttons will be displayed and one of them may be disabled. When showButtonsWhenNotScrollable
is set to true
and it is not possible to scroll in a given axis, then the scroll buttons will be displayed for that axis but will both be disabled.
NOTES
see the related left , right , up , and down child widgets |
|
the initial value is true |
IMPLEMENTATION INFO
this feature was introduced in this module |
5.25. wired
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6. Instance Methods
6.1. addChild
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.2. addChildren
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.3. ajax
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.4. buildHtml
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.5. callInherited
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.6. childHtml
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.7. childId
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.8. confirm
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.9. displayNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.10. fire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.11. flushNodeCache
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.12. get
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.13. getContainer
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.14. getHtml
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.15. getInherited
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.16. getNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.17. getNodeStyle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.18. getNodeValue
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.19. getProvider
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.20. globalizeNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.21. inform
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.22. injectNodeHtml
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.23. insertOrWireUi
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.24. insertUi
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.25. is
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.26. isMet
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.27. kill
Inherited from Uize.Widget
, but introduced in Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Class ) |
6.28. localize
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.29. met
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.30. nodeId
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.31. onChange
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.32. once
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.33. removeChild
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.34. removeNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.35. removeUi
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.36. set
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.37. setInherited
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.38. setNodeClipRect
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.39. setNodeInnerHtml
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.40. setNodeOpacity
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.41. setNodeProperties
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.42. setNodeStyle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.43. setNodeValue
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.44. showNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.45. toggle
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.46. unmet
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.47. unwire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.48. unwireNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.49. unwireNodeEventsByMatch
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.50. unwireUi
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.51. updateUi
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Widget ) |
6.52. valueOf
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class ) |
IMPLEMENTATION INFO
6.53. whenever
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.54. wire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
6.55. wireNode
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
6.56. wireUi
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
7. Static Methods
7.1. Uize.Widget.Scrolly.alphastructor
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.2. Uize.Widget.Scrolly.declare
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.3. Uize.Widget.Scrolly.doMy
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.4. Uize.Widget.Scrolly.dualContextMethods
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.5. Uize.Widget.Scrolly.dualContextProperties
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.6. Uize.Widget.Scrolly.fire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.7. Uize.Widget.Scrolly.get
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.8. Uize.Widget.Scrolly.getBlankImageUrl
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
7.9. Uize.Widget.Scrolly.instanceMethods
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.10. Uize.Widget.Scrolly.instanceProperties
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.11. Uize.Widget.Scrolly.mixins
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.12. Uize.Widget.Scrolly.omegastructor
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.13. Uize.Widget.Scrolly.set
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.14. Uize.Widget.Scrolly.singleton
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.15. Uize.Widget.Scrolly.spawn
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
7.16. Uize.Widget.Scrolly.stateProperties
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.17. Uize.Widget.Scrolly.staticMethods
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.18. Uize.Widget.Scrolly.staticProperties
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.19. Uize.Widget.Scrolly.subclass
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.20. Uize.Widget.Scrolly.toggle
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.21. Uize.Widget.Scrolly.treeInheritedStateProperties
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
7.22. Uize.Widget.Scrolly.unwire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
7.23. Uize.Widget.Scrolly.wire
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8. Static Properties
8.1. Uize.Widget.Scrolly.busyParentTickle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
8.2. Uize.Widget.Scrolly.enabledParentTickle
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
8.3. Uize.Widget.Scrolly.isWired
Inherited from Uize.Widget
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Widget , first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |
8.4. Uize.Widget.Scrolly.moduleName
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.5. Uize.Widget.Scrolly.nonInheritableStatics
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Class ) |
|
this static feature is not inherited by subclasses |
8.6. Uize.Widget.Scrolly.pathToResources
Inherited from Uize.Class
.
IMPLEMENTATION INFO
this is an inherited feature (implementation is in Uize.Class , first introduced in Uize.Class ) |
|
this static feature is inherited by subclasses |
8.7. Uize.Widget.Scrolly.undefined
IMPLEMENTATION INFO
this is an override of an inherited feature (implementation is in this module, first introduced in Uize.Widget ) |
|
this static feature is inherited by subclasses |