This class is a container for a group of
baselistitems. To use
baselist, baselistitem
must be subclassed to provide a visual representation of the list
item. It supports single select by default. Set
multiselect to true to allow multiple selection
(shift-click for a range, control-click for an arbitrary set).
Contained list items may be declared inside the list, such as:
<canvas height="100">
<baselist layout="axis:y;spacing:2">
<baselistitem height="15" width="25" bgcolor="${selected ? 0xffff00 : 0x0000ff}"/>
<baselistitem height="15" width="50" bgcolor="${selected ? 0xffff00 : 0x0000ff}"/>
<baselistitem height="15" width="100" bgcolor="${selected ? 0xffff00 : 0x0000ff}"/>
</baselist>
<text y="70">Click bar to select it.</text>
</canvas>
or replicated from data:
<canvas height="90">
<dataset name="items">
<item>one</item>
<item>two</item>
<item>three</item>
</dataset>
<class name="myitem" extends="baselistitem" bgcolor="${selected ? 0xffff00 : 0xffffff}">
<text text="${parent.value}"/>
</class>
<baselist layout="axis:y; spacing:2">
<myitem datapath="items:/item/text()"/>
</baselist>
<text y="70">Click on a number to select it.</text>
</canvas>
Optimizing Lists
If your lists represent data from a datapath, there are two optimizations that you may want to consider:
- pooling
- If you will be changing the data that is represented by the list
after it has been created, you can set
dataoption="pooling". For more about pooling see the datapath ??? attribute and the example inlist. - lazy
- If there are more items in the list than will be visible and all
list items are the same size (for example, in a scrolling list or
combobox), you should set dataoption="lazy". For more about lazy
replication see the datapath
??? attribute,
LzLazyReplicationManager, and the example inlist.
| Name | Type (tag) | Type (js) | Default | Category |
|---|---|---|---|---|
dataoption
|
string | String | none | read/write |
| One of "lazy", "resize", "pooling", "none". | ||||
defaultselection
|
expression | any | null | read/write |
| The index of the default selected item, if none is provided via the selected="true" attribute on an item. | ||||
itemclassname
|
string | String | read/write | |
| The name of the class for new items that will be created with addItem(). | ||||
multiselect
|
expression | any | false | read/write |
| If multiselect is true, multiple items may be selected. When the shift key is down, a range of items is selected. When the control key is down, any item may be added to the selection. | ||||
toggleselected
|
expression | any | false | read/write |
| When true, the first click on a list item selects it and the second click deselects it. | ||||
Attributes inherited from <baseformitem>
changed, ignoreform, rollbackvalue, submit, submitname, value
Attributes inherited from <basecomponent>
doesenter, enabled, hasdefault, isdefault, style, styleable, text
Attributes inherited from <view>
aaactive, aadescription, aaname, aasilent, aatabindex, align, bgcolor, cachebitmap, clickable, clickregion, clip, contextmenu, cursor, fgcolor, focusable, focustrap, font, fontsize, fontstyle, frame, framesloadratio, hassetheight, hassetwidth, height, layout, loadratio, mask, opacity, pixellock, playing, proxyurl, resource, resourceheight, resourcewidth, rotation, showhandcursor, source, stretches, subviews, totalframes, unstretchedheight, unstretchedwidth, valign, visibility, visible, width, x, xoffset, y, yoffset
Attributes inherited from <node>
classroot, cloneManager, datapath, defaultplacement, id, ignoreplacement, immediateparent, inited, initstage, name, nodeLevel, options, parent, placement, subnodes
Methods
-
addItem() -
Add an item to the end of the list. This method is not available with dataoption="lazy" or dataoption="resize" (use the data APIs instead).
Parameter Name Type Description text String the text for the item. value Object the value for the item.
-
clearSelection() -
-
getItem() -
Find a particular item by value. This method is not available with dataoption="lazy" or dataoption="resize" (use the data APIs instead).
-
getItemAt() -
Get a particular item by its index. This method is not available with dataoption="lazy" or dataoption="resize" (use the data APIs instead).
-
getNumItems() -
-
getSelection() -
Get the selection for the list. Normally this method returns views, but if dataoption="lazy" or dataoption="resize", it will return datapointers.
Returns Type Description Object null if no selection, an item if single select (default), or an array of items if multiselect.
-
getText() -
Returns Type Description Object null if no selection, a string if single select, or an array of strings if multiselect.
-
getValue() -
Returns Type Description Object null if no selection, a single value if single select, or an array of values if multiselect.
-
moveSelection() -
Move the selection to the next or previous view. This method not available with dataoption="lazy" or dataoption="resize"
-
removeAllItems() -
-
removeItem() -
Find the first item with the specified value and remove it from the list. This method is not available with dataoption="lazy" or dataoption="resize" (use the data APIs instead).
-
removeItemAt() -
Find the item at the specified index and remove it from the list. This method is not available with dataoption="lazy" or dataoption="resize" (use data APIs instead).
-
select() -
Parameter Name Type Description item lz.view the view to select (may be an array when multiselect == true)
-
selectItem() -
Select an item by value. This method is not available with dataoption="lazy" or dataoption="resize".
-
selectItemAt() -
-
selectNext() -
Move the selection to the next view. This method not available with dataoption="lazy" or dataoption="resize".
-
selectPrev() -
Move the selection to the previous view. This method not available with dataoption="lazy" or dataoption="resize".
-
setHilite() -
Methods inherited from <baseformitem>
commit, destroy, findForm, init, rollback, setChanged, setValue, toXML
Methods inherited from <basecomponent>
acceptValue, doEnterDown, doEnterUp, doSpaceDown, doSpaceUp, presentValue, setStyle, setTint, updateDefault
Methods inherited from <view>
bringToFront, containsPt, getAttributeRelative, getBounds, getColor, getColorTransform, getContextMenu, getCurrentTime, getDepthList, getID3, getMouse, getNextSelection, getPan, getPrevSelection, getProxyURL, getTotalTime, getVolume, init, measureHeight, measureWidth, play, proxyurl, releaseLayouts, searchSubviews, seek, sendAAEvent, sendBehind, sendInFrontOf, sendToBack, setAAActive, setAADescription, setAAName, setAASilent, setAATabIndex, setAccessible, setAlign, setAttributeRelative, setBGColor, setClickable, setColor, setColorTransform, setContextMenu, setCursor, setHeight, setLayout, setOpacity, setPan, setPlay, setProxyPolicy, setProxyURL, setResource, setResourceNumber, setRotation, setShowHandCursor, setSource, setValign, setVisibility, setVisible, setVolume, setWidth, setX, setXOffset, setY, setYOffset, shouldYieldFocus, stop, stretchResource, unload, updateResourceSize
Methods inherited from <node>
animate, applyConstraint, applyConstraintMethod, applyData, childOf, completeInstantiation, construct, createChildren, dataBindAttribute, destroy, determinePlacement, getAttribute, getOption, getUID, init, lookupSourceLocator, releaseConstraint, releaseConstraintMethod, searchImmediateSubnodes, searchSubnodes, setData, setDatapath, setOption, setSelected, updateData
Events
| Name | Description |
|---|---|
onselect
|
This event is triggered whenever the user makes a selection it may used as a script in the tag or as an event method. |
Events inherited from <view>
onaddsubview, onblur, onclick, ondblclick, onerror, onfocus, onframe, onframesloadratio, onheight, onkeydown, onkeyup, onlastframe, onload, onloadratio, onmousedown, onmousedragin, onmousedragout, onmouseout, onmouseover, onmouseup, onmouseupoutside, onopacity, onplay, onremovesubview, onstop, ontimeout, onvisible, onwidth, onx, ony