<basegridcolumn>

An abstract column in a grid.

JavaScript: basegridcolumn

Extends Basecomponent

basegridcolumn can be used in basegrids or grids to customize the look of both the column header and the row contents for that column. In cases where a standard column header look is desired, but the contents may vary, use gridcolumn.

The placement of "header" can be used to place nodes in the header of the grid, and the default placement for the class will place things in the row. See the example in basegrid.

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

An optional method. If defined, this method will be used when the column is sorted when ascendsort is set to true. This method should have the compartor signature. It should accept to string argument and return 1, 0 , or -1, indicating that the two arguments are in order, equivalent, or out of order, respectively.


ascendsort Tag & JS expression any true setter
 

If true, the next sort will be ascending, otherwise it will be descending.


colwidth Tag & JS expression any   setter
 

The current width of the column.


datatype Tag & JS string String string setter
 

Either "number" or "string". If "string", then dictionary sort is used. If "number", then types are coerced to a number before sorting.


descendComparator Tag & JS expression any null setter
 

An optional method. If defined, this method will be used when the column is sorted when ascendsort is set to false. This method should have the compartor signature. It should accept to string argument and return 1, 0 , or -1, indicating that the two arguments are in order, equivalent, or out of order, respectively.


hasSort Tag & JS boolean Boolean false setter
 

Readonly; set by doSort method. If true, then this is the current sort column.


minwidth Tag & JS number Number 10 setter
 

The minimum width for this column. This is relevant if the column can be resized.


sortpath Tag & JS string String   setter
 

An xpath expression to use to determine the sort key for this column. By default, this is the column's datapath's xpath.



Attributes inherited from Basecomponent

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

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

doSort()
basegridcolumn.doSort()

Sorts the grid on the current column using the column's sortpath and ascendsort arguments.



Methods inherited from basecomponent

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

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

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