com.saperion.ngc.resultset

Class ResultListImpl

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.impl.MeshElement

org.zkoss.zul.Listbox

com.saperion.ngc.resultset.ResultListImpl

All Implemented Interfaces:

ResultList, Serializable, Cloneable, org.zkoss.zk.ui.api.HtmlBasedComponent, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.api.Listbox, org.zkoss.zul.ext.Paginated, org.zkoss.zul.impl.api.MeshElement, org.zkoss.zul.impl.api.XulElement

public class ResultListImpl
extends org.zkoss.zul.Listbox
implements ResultList

Default-implementation of ResultList. This implementation extends Listbox.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.zkoss.zul.Listbox

org.zkoss.zul.Listbox.Children, org.zkoss.zul.Listbox.ExtraCtrl

Field Summary

Fields inherited from class org.zkoss.zul.Listbox

LOADING_MODEL, SYNCING_MODEL

Fields inherited from class org.zkoss.zk.ui.HtmlBasedComponent

_zclass

Fields inherited from interface org.zkoss.zk.ui.Component

APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE

Fields inherited from interface org.zkoss.zk.ui.sys.ComponentCtrl

CE_BUSY_IGNORE, CE_DUPLICATE_IGNORE, CE_IMPORTANT, CE_NON_DEFERRABLE, CE_REPEAT_IGNORE

Constructor Summary

Constructors

Constructor and Description
ResultListImpl()

Method Summary

Methods

Modifier and Type	Method and Description
List<ResultListItem>	getAllListItems()
List<HeaderInformation>	getHeaderInformation() Returns information about the headers representing the columns of this ResultList.
int	getListItemCount()
int	getSelectedListIndex()
DraggableListItem	getSelectedListItem()
List<ResultListItem>	getSelectedListItems()
void	init(ResultSetViewImpl parent, ResultSetPresenter presenter) Gets called directly after the new instance was created.
void	renderQueryResult(List<ResultProperties> resultList) Renders the list of properties that represents the result of the previous query.
void	service(org.zkoss.zk.au.AuRequest request, boolean everError)
void	setContextMenu(org.zkoss.zul.Menupopup popup) Sets a Menupopup to be used as context-menu of this ResultList.
void	setSelectedListIndex(int index) Selects the item with the specified index in the list.
void	updateRow(ResultProperties properties, boolean selected) Updates the row identified by the provided properties.

Methods inherited from class org.zkoss.zul.Listbox

addItemToSelection, addItemToSelectionApi, afterInsert, appendItem, appendItemApi, beforeChildAdded, beforeRemove, clearSelection, clone, getChildren, getEmptyMessage, getExtraCtrl, getFrozen, getGroupCount, getGroups, getGroupsModel, getHeads, getIndexOfItem, getIndexOfItemApi, getInnerWidth, getItemAtIndex, getItemAtIndexApi, getItemCount, getItemRenderer, getItems, getListfoot, getListfootApi, getListhead, getListheadApi, getListModel, getMaxlength, getModel, getName, getNonselectableTags, getOddRowSclass, getPaginal, getPagingChild, getPagingChildApi, getPreloadSize, getRows, getSelectedCount, getSelectedIndex, getSelectedItem, getSelectedItemApi, getSelectedItems, getSeltype, getTabindex, getVisibleItemCount, getZclass, hasGroup, insertBefore, isCheckmark, isDisabled, isFixedLayout, isMultiple, isVflex, onInitRender, onPageAttached, onPagingInitRender, pgi, removeChild, removeItemAt, removeItemAtApi, removeItemFromSelection, removeItemFromSelectionApi, renderAll, renderItem, renderItemApi, renderItems, renderProperties, selectAll, selectItem, selectItemApi, sessionDidActivate, sessionWillPassivate, setActivePage, setActivePage, setCheckmark, setDisabled, setEmptyMessage, setFixedLayout, setInnerWidth, setItemRenderer, setItemRenderer, setMaxlength, setModel, setModel, setMold, setMultiple, setName, setNonselectableTags, setOddRowSclass, setPaginal, setPreloadSize, setRows, setSelectedIndex, setSelectedItem, setSelectedItemApi, setSelectedItems, setSeltype, setTabindex, setVflex, toggleItemSelection, toggleItemSelectionApi

Methods inherited from class org.zkoss.zul.impl.MeshElement

getActivePage, getPageCount, getPageSize, getPagingPosition, getSpan, isAutopaging, isSizedByContent, isSpan, setActivePage, setAutopaging, setPageSize, setPagingPosition, setSizedByContent, setSpan, setSpan

Methods inherited from class org.zkoss.zul.impl.XulElement

getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from class org.zkoss.zk.ui.HtmlBasedComponent

focus, getAction, getDraggable, getDroppable, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDraggable, setDroppable, setFocus, setHeight, setHeightDirectly, setHflex, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setTopDirectly, setVflex, setWidth, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly

Methods inherited from class org.zkoss.zk.ui.AbstractComponent

addAnnotation, addAnnotation, addClientEvent, addEventHandler, addEventListener, addForward, addForward, addForward, addForward, addMoved, addScopeListener, addSharedAnnotationMap, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, containsVariable, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableClientUpdate, equals, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, newChildren, newExtraCtrl, onChildAdded, onChildRemoved, onPageDetached, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, renderIdSpace, response, response, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, unsetVariable, updateByClient, willPassivate, willPassivate, willSerialize, willSerialize

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.zkoss.zk.ui.Component

addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, containsVariable, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getChildren, getDefinition, getDesktop, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getSpaceOwner, getStubonly, getUuid, getVariable, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, unsetVariable

Methods inherited from interface org.zkoss.zk.ui.ext.Scope

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Methods inherited from interface org.zkoss.zul.impl.api.MeshElement

getActivePage, getPageCount, getPageSize, getSpan, isAutopaging, isSizedByContent, isSpan, setActivePage, setAutopaging, setPageSize, setPagingPosition, setSizedByContent, setSpan, setSpan

Methods inherited from interface org.zkoss.zul.impl.api.XulElement

getContext, getCtrlKeys, getPopup, getTooltip, setContext, setContext, setCtrlKeys, setPopup, setPopup, setTooltip, setTooltip

Methods inherited from interface org.zkoss.zk.ui.api.HtmlBasedComponent

focus, getHeight, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getWidth, getZindex, getZIndex, setDraggable, setDroppable, setFocus, setHeight, setLeft, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

Methods inherited from interface org.zkoss.zul.ext.Paginated

getPagingPosition

Constructor Detail

ResultListImpl

public ResultListImpl()

Method Detail

init

public void init(ResultSetViewImpl parent,
        ResultSetPresenter presenter)

Description copied from interface: ResultList

Gets called directly after the new instance was created. This method is meant to be used to perform any necessary initialization-tasks.

Specified by:

init in interface ResultList

Parameters:

parent - the ResultSetViewImpl instance using this ResultList

presenter - the ResultSetPresenter used by the parent

service

public void service(org.zkoss.zk.au.AuRequest request,
           boolean everError)

Specified by:

service in interface org.zkoss.zk.ui.sys.ComponentCtrl

Overrides:

service in class org.zkoss.zul.Listbox

getListItemCount

public int getListItemCount()

Specified by:

getListItemCount in interface ResultList

Returns:

the number of items contained in this ResultList

setSelectedListIndex

public void setSelectedListIndex(int index)

Description copied from interface: ResultList

Selects the item with the specified index in the list. All other items will be deselected.

Specified by:

setSelectedListIndex in interface ResultList

Parameters:

index - index of the item to select

getSelectedListIndex

public int getSelectedListIndex()

Specified by:

getSelectedListIndex in interface ResultList

Returns:

the index of the currently selected item in the list or -1 if no item is selected

getAllListItems

public List<ResultListItem> getAllListItems()

Specified by:

getAllListItems in interface ResultList

Returns:

a list of all items contained in this ResultList. Never null. Modifications on this list will not take effect on the ResultList.

getSelectedListItems

public List<ResultListItem> getSelectedListItems()

Specified by:

getSelectedListItems in interface ResultList

Returns:

a list of all selected items of this ResultList. Never null. Modifications on this list will not take effect on the ResultList.

getSelectedListItem

public DraggableListItem getSelectedListItem()

Specified by:

getSelectedListItem in interface ResultList

Returns:

the item currently selected in the list or null if no item is selected

renderQueryResult

public void renderQueryResult(List<ResultProperties> resultList)

Description copied from interface: ResultList

Renders the list of properties that represents the result of the previous query. The list will never be null or empty, because empty results are handled by the parent-view.

Specified by:

renderQueryResult in interface ResultList

Parameters:

resultList - list of properties to render

updateRow

public void updateRow(ResultProperties properties,
             boolean selected)

Description copied from interface: ResultList

Updates the row identified by the provided properties. The properties will contain the same original index as the old row that is to be updated. Whether the updated row will be marked as unread or not is up to the implementation. Also, the implementation must decide if a viewer or an embedded index-form will be updated automatically.

Specified by:

updateRow in interface ResultList

Parameters:

properties - the metadata for the updated row

selected - if true, the updated row must be set selected

setContextMenu

public void setContextMenu(org.zkoss.zul.Menupopup popup)

Description copied from interface: ResultList

Sets a Menupopup to be used as context-menu of this ResultList. Implementations can either use the given context-menu or use this method as a notification to create or update their own context menu. This method gets called when

• the parent view is cleared
• the parent view is initialized
• a query result was rendered

Specified by:

setContextMenu in interface ResultList

Parameters:

popup - default context-menu-popup

getHeaderInformation

public List<HeaderInformation> getHeaderInformation()

Description copied from interface: ResultList

Returns information about the headers representing the columns of this ResultList. If no columns are used, this method returns an empty list.

Specified by:

getHeaderInformation in interface ResultList

Returns:

header-information or an empty list. Never null.