Difference between revisions of "ScrollPanel"
From Lianjapedia
Barrymavin (Talk | contribs) (Created page with "Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages. ====Description==== Creates a scrollable container. A Scrol...") |
Yvonne.milne (Talk | contribs) (→Methods) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
====Description==== | ====Description==== | ||
| + | Shown below in a standalone [[Form]]. Click the image to see in a [[Custom_Sections_and_Gadgets|Custom Section]] in a Lianja [[Page Attributes|Page]]. | ||
| + | |||
| + | [[{{ns:file}}:scrollpanel.png|link={{filepath:container_scrollpanel_cs.png}}|ScrollPanel]] | ||
Creates a scrollable container. | Creates a scrollable container. | ||
| Line 9: | Line 12: | ||
====Properties==== | ====Properties==== | ||
| − | This class supports the [[:Category:Common_Properties|Common Properties]] | + | This class supports the [[:Category:Common_Properties|Common Properties]] plus the following: |
| + | |||
| + | {| class="wikitable" width="100%" | ||
| + | !width="20%"|Property | ||
| + | !Access (R/RW) | ||
| + | !Value | ||
| + | !width="50%"|Description | ||
| + | |- | ||
| + | |valign="top"|KineticScrolling | ||
| + | |valign="top"|RW | ||
| + | |valign="top"|Boolean | ||
| + | |valign="top"|Whether kinetic scrolling is enabled, default is False. With kinetic scrolling, the user can flick in a given direction and it will continue to scroll in this direction until it is stopped either by the user or by friction. Setting KineticScrolling to true provides touch scrolling on touch aware devices and left mouse button pressed and moved scrolling on non-touch aware devices. | ||
| + | |- | ||
| + | |} | ||
====Methods==== | ====Methods==== | ||
| Line 23: | Line 39: | ||
|valign="top"|existing as Object | newobject as Character, class as Character | |valign="top"|existing as Object | newobject as Character, class as Character | ||
|valign="top"|Add an existing object or a new object, in which case the object's class must also be specified | |valign="top"|Add an existing object or a new object, in which case the object's class must also be specified | ||
| + | |- | ||
| + | |valign="top"|EnsureVisible | ||
| + | |valign="top"|x as Numeric, y as Numeric | ||
| + | |valign="top"|Scroll if required to ensure that the specified position is visible | ||
|- | |- | ||
|Removeobject | |Removeobject | ||
|existing as Object | |existing as Object | ||
|Remove the specified object | |Remove the specified object | ||
| + | |- | ||
| + | |valign="top"|ScrollBy | ||
| + | |valign="top"|xpixels as Numeric, ypixels as Numeric | ||
| + | |valign="top"|Scroll by the specified number of pixels | ||
| + | |- | ||
| + | |valign="top"|ScrollTo | ||
| + | |valign="top"|x as Numeric, y as Numeric | ||
| + | |valign="top"|Scroll to the specified position | ||
|- | |- | ||
|} | |} | ||
| Line 36: | Line 64: | ||
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Framework Classes]] | [[Category:Framework Classes]] | ||
| + | [[Category:Lianja v4.1]] | ||
Latest revision as of 06:24, 13 April 2018
Note: property, method and event names should be referred to in lowercase in case-sensitive scripting languages.
Contents
Description
Shown below in a standalone Form. Click the image to see in a Custom Section in a Lianja Page.
Creates a scrollable container.
A ScrollPanel is a container object that contains a large Container or Image UIcontrol. Scroll bars are visible if the UIcontrol embedded in it is bigger than the ScrollPanel itself.
Properties
This class supports the Common Properties plus the following:
| Property | Access (R/RW) | Value | Description |
|---|---|---|---|
| KineticScrolling | RW | Boolean | Whether kinetic scrolling is enabled, default is False. With kinetic scrolling, the user can flick in a given direction and it will continue to scroll in this direction until it is stopped either by the user or by friction. Setting KineticScrolling to true provides touch scrolling on touch aware devices and left mouse button pressed and moved scrolling on non-touch aware devices. |
Methods
This class supports the Common Methods plus the following:
| Method | Args | Description |
|---|---|---|
| AddObject | existing as Object | newobject as Character, class as Character | Add an existing object or a new object, in which case the object's class must also be specified |
| EnsureVisible | x as Numeric, y as Numeric | Scroll if required to ensure that the specified position is visible |
| Removeobject | existing as Object | Remove the specified object |
| ScrollBy | xpixels as Numeric, ypixels as Numeric | Scroll by the specified number of pixels |
| ScrollTo | x as Numeric, y as Numeric | Scroll to the specified position |
Events
This class supports the Common Events.
