<vscrollbar>

Provides a vertical scrollbar.

JavaScript: vscrollbar

Extends Basescrollbar

This tag creates a vertical scrollbar. If you do not specify a scrolltarget the scrollbar will automatically be aligned to the right and size its height to its parent's height. It is expected that the parent view be smaller than the scrolltarget and set clip=true. The scrolling effect is produced by moving the scrolltarget while its visible region is clipped by the parent view.

If you would like the target view to start scrolled, simply set its y position to a negative number. For example, y=-10 will cause the view to be scrolled 10 pixels.

Note: If you have no horizontal scrollbars in your application, using the <vscrollbar> tag will make the applications slightly smaller, than if you were to use <scrollbar axis="y">.

Example 1. Simple scrollbar
<canvas height="160" bgcolor="silver">
  <view name="main" x="20" y="20" bgcolor="white"
        width="100" height="80" clip="true">
    <view name="contents">
      <text multiline="true">
        1<br/>2<br/>3<br/>4<br/>5<br/>6<br/>7<br/>8<br/>9<br/>10
      </text>
    </view>
    <vscrollbar/>
  </view>
</canvas>

In the example above, the scrolltarget is the contents view. A scrollbar moves its scrolltarget along its axis. The attribute that is controlled by the scrollbar may be specified as the scrollattr, overriding the default value of x or y.

Attributes
Name Usage Type (Tag) Type (JS) Default Category
disabledbgcolor Tag & JS expression any null setter
 

If this is defined, it will be used as the scrollbar's background color when it is disabled. If not provided, the scrollbar will use the bgcolor of its closest parent that has a bgcolor defined.



Attributes inherited from Basecomponent

doesenter, enabled, hasdefault, isdefault, style, styleable, text

Attributes inherited from Basescrollbar

axis, focusview, mousewheelactive, mousewheelevent_off, mousewheelevent_on, pagesize, scrollable, scrollattr, scrollmax, scrolltarget, stepsize, usemousewheel

Attributes inherited from Node

class, classroot, cloneManager, datapath, id, ignoreAttribute, ignoreplacement, immediateparent, initstage, name, nodeLevel, onconstruct, oninit, parent, placement, subnodes

Attributes inherited from View

aaactive, aadescription, aaname, aasilent, aatabindex, align, bgcolor, clickable, clickregion, clip, cursor, defaultplacement, fgcolor, focusable, focustrap, font, fontsize, fontstyle, frame, framesloadratio, hassetheight, hassetwidth, height, layout, loadratio, mask, onblur, onclick, ondata, ondblclick, onfocus, onkeydown, onkeyup, onmousedown, onmouseout, onmouseover, onmouseup, onselect, opacity, options, pixellock, play, resource, resourceheight, resourcewidth, rotation, selectiontype, showhandcursor, source, stretches, subviews, totalframes, unstretchedheight, unstretchedwidth, valign, visible, width, x, xoffset, y, yoffset


Methods

Methods inherited from basecomponent

doEnterDown, doEnterUp, doSpaceDown, doSpaceUp, setStyle, setTint, updateDefault

Methods inherited from basescrollbar

page, step

Methods inherited from LzNode

animate, applyConstraint, applyData, childOf, completeInstantiation, createChildren, dataBindAttribute, destroy, determinePlacement, getAttribute, getOption, getUID, lookupSourceLocator, searchImmediateSubnodes, searchSubnodes, setAttribute, setDatapath, setID, setName, setOption

Methods inherited from LzView

addProxyPolicy, addSubview, bringToFront, construct, containsPt, getAttributeRelative, getBounds, getColor, getColorTransform, getContextMenu, getCurrentTime, getDepthList, getHeight, getID3, getMouse, getPan, getTotalTime, getVolume, getWidth, init, measureHeight, measureWidth, play, releaseLayouts, removeProxyPolicy, searchParents, searchSubviews, seek, sendBehind, sendInFrontOf, sendToBack, setAAActive, setAADescription, setAAName, setAASilent, setAATabIndex, setAlign, setAttributeRelative, setBGColor, setClickable, setColor, setColorTransform, setContextMenu, setCursor, setHeight, setLayout, setOpacity, setPan, setPlay, setResource, setResourceNumber, setRotation, setShowHandCursor, setSource, setValign, setVisible, setVolume, setWidth, setX, setY, shouldYieldFocus, stop, stretchResource, unload, updateResourceSize


Events
Name Description
onscrollmax None

Events inherited from basescrollbar

onscrollmax

Events inherited from LzNode

onconstruct, ondata, oninit

Events inherited from LzView

onaddsubresource, onaddsubview, onblur, onclick, ondblclick, onerror, onfocus, onframe, onheight, onlastframe, onload, onmousedown, onmousedragin, onmousedragout, onmouseout, onmouseover, onmouseup, onmouseupoutside, onopacity, onplay, onremovesubview, onstop, ontimeout, onwidth, onx, ony