Zimlet JavaScript API Reference - ZmListView

Class ZmListView


Extends DwtListView.

A list view presents a list of items as rows with fields (columns).

Defined in: ZmListView.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmListView(params)
Creates a list view.
Method Summary
Method Attributes Method Name and Description
 
Deselects all items.
 
Gets the controller.
 
Returns the underlying ZmList.
 
getLimit(offset)
Gets the limit value.
 
Gets the pageless threshold.
 
Gets the replenish threshold.
 
Gets the tool tip content.
<static>  
ZmListView.handleScroll(ev)
Scroll-based paging.
 
hasItem(item)
Checks if the given item is in this view's list.
 
selectAll(allResults)
Selects all items.
 
setSelectedItems(selectedArray, dontCheck)
Sets the selected items.
 
setSelectionCbox(obj, bContained)
Sets the selection checkbox.
 
Sets the selection header checkbox.
Methods borrowed from class DwtListView:
addActionListener, addItem, addItems, addSelectionListener, addStateChangeListener, findItem, findItemDiv, getItemIndex, getSelectedItems, getSelectionCount, getTargetItem, getTargetItemDiv, removeActionListener, removeAll, removeItem, removeSelectionListener, removeStateChangeListener, scrollPage, selectItem, set, setEnabled, setSize, setUI, size, useListElement
Methods borrowed from class DwtComposite:
addChild, cleanupSeparators, clear, dispose, getChild, getChildren, getNumChildren, getTabGroupMember, removeChild, removeChildren
Methods borrowed from class DwtControl:
addClassName, addControlListener, addDisposeListener, addListener, appendElement, blur, clearContent, clearHandler, condClassName, delClassName, focus, getBounds, getClassName, getContent, getCursor, getData, getDragBox, getDragSource, getDropTarget, getEnabled, getFocusElement, getH, getHtmlElement, getHTMLElId, getInsetBounds, getInsets, getLocation, getMargins, getOpacity, getOuterSize, getPosition, getScrollContainer, getScrollStyle, getSize, getTooltipBase, getVisibility, getVisible, getW, getX, getXW, getY, getYH, getZIndex, hasFocus, isAlertShown, isDisposed, isInitialized, isListenerRegistered, notifyListeners, preventContextMenu, preventSelection, removeAllListeners, removeControlListener, removeDisposeListener, removeListener, reparent, reparentHtmlElement, replaceElement, setBounds, setClassName, setContent, setCursor, setData, setDisplay, setDisplayState, setDragBox, setDragSource, setDropTarget, setEventPropagation, setFocusElement, setHandler, setHtmlElementId, setLocation, setOpacity, setPosition, setScrollStyle, setToolTipContent, setVisibility, setVisible, setZIndex, showAlert, zShow
Class Detail
ZmListView(params)
Creates a list view.
Author: Parag Shah, Conrad Damon.
Parameters:
{Hash} params
a hash of parameters
{DwtComposite} params.parent
the parent widget
{String} params.className
the CSS class
{constant} params.posStyle
the positioning style
{String} params.id
the HTML ID for element
{Array} params.headerList
the list of IDs for columns
{Boolean} params.noMaximize
if true, all columns are fixed-width (otherwise, one will expand to fill available space)
{constant} params.view
the ID of view
{constant} params.type
the type of item displayed
{ZmListController} params.controller
the owning controller
{DwtDropTarget} params.dropTgt
the drop target
{Boolean} params.pageless
if true, enlarge page via scroll rather than pagination
Method Detail
deselectAll()
Deselects all items.

{ZmListController} getController()
Gets the controller.
Returns:
{ZmListController} the list controller

getItemList()
Returns the underlying ZmList.

{int} getLimit(offset)
Gets the limit value.
Parameters:
{Boolean} offset
if true, offset
Returns:
{int} the limit page size

{int} getPagelessThreshold()
Gets the pageless threshold.
Returns:
{int} the pageless threshold

{int} getReplenishThreshold()
Gets the replenish threshold.
Returns:
{int} the replenish threshold

{String} getToolTipContent(ev)
Gets the tool tip content.
Parameters:
{Object} ev
the hover event
Returns:
{String} the tool tip content

<static> ZmListView.handleScroll(ev)
Scroll-based paging. Make sure we have at least one page of items below the visible list.
Parameters:
ev

{Boolean} hasItem(item)
Checks if the given item is in this view's list. Note that the view's list may be only part of the controller's list (the currently visible page).
Parameters:
{String|ZmItem} item
the item ID, or item to check for
Returns:
{Boolean} true if the item is in the list

selectAll(allResults)
Selects all items.
Parameters:
{Boolean} allResults
if true, set all search selected

setSelectedItems(selectedArray, dontCheck)
Sets the selected items.
Parameters:
{Array} selectedArray
an array of {Element} objects to select
{boolean} dontCheck
do not check the selected item. (special case. see ZmListView.prototype._restoreState)

setSelectionCbox(obj, bContained)
Sets the selection checkbox.
Parameters:
{Element} obj
the item element object
{Boolean} bContained
(not used)

setSelectionHdrCbox(check)
Sets the selection header checkbox.
Parameters:
{Boolean} check
if true, check the header checkbox

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:41 GMT-0400 (EDT)