ResultSetView (webclient 8.0.0-0 API)

All Superinterfaces:

Cloneable, org.zkoss.zk.ui.Component, EventChild, EventChildHandler, LogEventChildHandler, org.zkoss.zk.ui.ext.Scope, Serializable

All Known Implementing Classes:

ResultSetViewImpl
```
public interface ResultSetView
extends org.zkoss.zk.ui.Component, EventChild, EventChildHandler
```
Represents a result list in a form.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ResultSetView.DefaultButtonType` Actions to be performed, when user double-clicks an item.
`static class`	`ResultSetView.ExportFormat` Possible formats used to export a query result.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CONTEXT_TIMEOUT` Timeout for context menus.
`static String`	`DATABASE_NAME` Attribute name for database name.
`static int`	`DEFAULT_BUTTON_DELETE_ID` QBE id for default button delete.
`static int`	`DEFAULT_BUTTON_EDIT_ID` QBE id for default button edit.
`static int`	`DEFAULT_BUTTON_INDEX_ID` QBE id for default button index.
`static int`	`DEFAULT_BUTTON_PRINT_ID` QBE id for default button print.
`static int`	`DEFAULT_BUTTON_SAVE_ID` QBE id for default button save.
`static int`	`DEFAULT_BUTTON_SECURITY_ID` QBE id for default button security.
`static int`	`DEFAULT_BUTTON_VIEW_ID` QBE id for default button view.
`static int`	`DEFAULT_RIGHTS_MASK` Bitmask with default menu entries enabled.
`static String`	`DISPLAY_NAME` Attribute name for display name.
`static int`	`FILTER_COLS` Length of the filter box.
`static int`	`FILTER_TIMEOUT` Timeout for filter operation.
`static int`	`MAX_COUNT_FOR_CLIENTSIDE_FUNCTIONS` Maximum amount of items allowed in a result to use client side functions.
`static int`	`RSS_BUTTONDELETE` ResStyle bitmask entry for delete-button.
`static int`	`RSS_BUTTONEDIT` ResStyle bitmask entry for edit-button.
`static int`	`RSS_BUTTONINDEX` ResStyle bitmask entry for index-button.
`static int`	`RSS_BUTTONNEW` ResStyle bitmask entry for new-button.
`static int`	`RSS_BUTTONPRINT` ResStyle bitmask entry for print-button.
`static int`	`RSS_BUTTONSAVE` ResStyle bitmask entry for save-button.
`static int`	`RSS_BUTTONSECURITY` ResStyle bitmask entry for security-button.
`static int`	`RSS_BUTTONVIEW` ResStyle bitmask entry for view-button.
`static int`	`RSS_CONDITION` ResStyle bitmask entry for condition-option.
`static int`	`RSS_OUTLINE` ResStyle bitmask entry for outliner-view.
`static int`	`RSS_RESTRICTCURSOR` ResStyle bitmask entry for restrict-cursor-option.
`static int`	`RSS_SINGLECLICK` ResStyle bitmask entry for singleclick-option.
`static String`	`WF_BOX_ID` Name of box id property.

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 com.saperion.ngc.events.EventChild
ALL_EVENTS, ON_ADD_LINK, ON_ADD_LOOKUP, ON_ADD_TO_FAVORITES, ON_AFTER_QUERY, ON_BUTTON, ON_BUTTON_QUERY, ON_CANCEL, ON_CANCEL_AND, ON_CANCEL_EDIT, ON_CHANGE_DOCUMENT_SECURITY, ON_CHANGE_FOLDER_SECURITY, ON_CLEAR, ON_DELETE_SELECTED, ON_DISPLAY_POPUP, ON_DISPLAY_RESULTITEM, ON_DISPLAY_TEMPORARY_DOCUMENT, ON_DOCUMENT_ADDED, ON_DOCUMENT_CHECK, ON_DOCUMENT_FILING, ON_DOCUMENT_LOCKED, ON_DOCUMENT_RELEASE, ON_DOWNLOAD_RESULTITEM, ON_EDIT_CONTENT, ON_EDIT_FOLDER, ON_EDIT_ITEM, ON_EDIT_ITEM_SELECTED, ON_EDIT_LOOKUP, ON_EDIT_SELECTED, ON_EDIT_STRUCTURE, ON_EXPORT, ON_FAST_ACCESS_DRAG_OVER, ON_FIELD_CHANGE, ON_FILE_ACTION, ON_FILE_PREVIEW, ON_FILE_SEARCH, ON_FORM_CREATED, ON_FORM_RENDER_ERROR, ON_FORWARD, ON_IGNORE, ON_INDEX, ON_INDEX_CLEAR, ON_INDEX_RESULTITEM, ON_ITEM_DOUBLECLICK, ON_LAUNCH_WORKFLOW, ON_LOG, ON_LOGON, ON_MACRO, ON_NAVIGATION, ON_NAVIGATION_FOLDER, ON_NAVIGATION_FORM, ON_NAVIGATION_WEBPART, ON_NEW_ITEM, ON_NEW_SELECTED, ON_OK, ON_OPEN_INDEX_MASK, ON_OPEN_MASK, ON_OPEN_QUERY_MASK, ON_PASSWORD_EXPIRED, ON_PRINT_DOCUMENTS, ON_QUERY, ON_QUERY_FAVORITE, ON_REFRESH, ON_REFRESH_FOLDER, ON_RESET_GUI, ON_REVISION_CREATED, ON_SAVE_AND, ON_SAVE_DOC, ON_SAVE_FOLDER, ON_SCROLL_NODE, ON_SELECT_TREE_ITEM, ON_SELECTDDC, ON_SEND_MAIL_RESULTITEM, ON_START_WORKFLOW, ON_TAB_SELECTED, ON_UNDELETE_SELECTED, ON_UPLOAD_DOCUMENT, ON_UPLOAD_SUCCESS, ON_VARIABLES_AVAILABLE, ON_WF, ON_WF_COMMENT_DIALOG_CANCEL, ON_WF_COMMENT_DIALOG_OK, ON_WFCOMMENTS, ON_WFDELEGATE, ON_WFFORWARD, ON_WFFORWARD1, ON_WFFORWARD2, ON_WFFORWARD3, ON_WFFORWARD4, ON_WFFORWARD5, ON_WFHISTORY, ON_WFPUTBACK, ON_WFREMINDER, ON_WFTAKE, ON_WORKFLOW_ACTION, ON_WORKFLOW_COMMENT

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCustomCondition(FieldResultBean condition)` Adds a condition that will be used each time this ResultSetView performs a query.
`void`	`addCustomMenu(org.zkoss.zul.Menu menu, boolean multi)` Adds a custom menu.
`void`	`addCustomMenuItem(org.zkoss.zul.Menuitem item, boolean multi)` Adds a custom menu item.
`void`	`clearResultSet()` Clears the result set.
`void`	`deleteConfiguration()` Deletes the stored configuration of the columns (width and sort-direction).
`void`	`export()` Exports the current query result.
`void`	`export(Map<String,String> columnsToExport, ResultSetView.ExportFormat format, String filename)` Exports the current query result.
`String`	`getAllowed()`
`List<ResultProperties>`	`getAllRows()` Returns a list containing the properties of all rows.
`org.zkoss.zul.Menupopup`	`getContextMenuPopup()` Returns the popup of the context menu.
`List<FieldResultBean>`	`getCustomConditions()`
`List<org.zkoss.zul.Menuitem>`	`getCustomMenuItems(boolean multi)` Returns the custom menu items.
`List<org.zkoss.zul.Menu>`	`getCustomMenus(boolean multi)` Returns the custom menus.
`Map<String,SortDirection>`	`getCustomSortSequences()`
`ResultSetView.DefaultButtonType`	`getDefaultButtonType()`
`boolean`	`getDefaultMenu()`
`String`	`getFieldsToDisplay()`
`String`	`getFormName()`
`String`	`getHeaderAlignments()`
`String`	`getHeaderNames()`
`String`	`getHeaderWidths()`
`String`	`getIndexMask()`
`int`	`getNumberOfIndexes()` Returns the number of items in this list.
`int`	`getOriginalItemIndex()` Returns the original index of the currently selected item or -1 if no item is selected.
`int`	`getPageSize()`
`IntelligentFormView`	`getParentForm()` Returns the parent form or null if this field is not part of a form.
`PropertyToStringConverter`	`getPropertyConverter()` Returns the converter that is used to convert `SaPropertyValue` instances to strings.
`List<MenuItemKey>`	`getRemoveMenuItemList(boolean multi)` Reads the list of remove menu items.
`ResultList`	`getResultSetList()` Returns the `ResultList` used in this ResultSetView.
`com.saperion.ngc.iform.xml.ResultType`	`getResultType()` Returns the `ResultType` that contains the properties of this ResultSetView as defined in the QBE-form.
`SearchMode`	`getSearchMode()`
`List<DocumentId>`	`getSelectedIds()` Returns the IDs of the selected documents.
`int`	`getSelectedIndex()` Returns the currently selected index.
`DraggableListItem`	`getSelectedItem()` Deprecated. use `getSelectedListItem()` instead. Will be removed in 8.1.
`Set<DraggableListItem>`	`getSelectedItems()` Deprecated. use `getSelectedListItems()` instead. Will be removed in 8.1.
`ResultListItem`	`getSelectedListItem()` Returns the selected item.
`Set<ResultListItem>`	`getSelectedListItems()` Returns all selected items.
`List<ResultProperties>`	`getSelectedRows()` Returns a list containing the properties of the selected rows.
`String`	`getSelectQuery()`
`String`	`getSortingDirections()`
`int`	`getTotalSize()` Returns the total size of the last query result.
`void`	`initializePaging(ResultPaging paging)` Initialize paging options.
`boolean`	`isAutoSearch()`
`boolean`	`isExportEnabled()`
`boolean`	`isFilterViewShown()`
`boolean`	`isSaveFavoriteEnabled()`
`boolean`	`isSaveLayout()` Checks if save layout is enabled.
`boolean`	`isSimpleMode()`
`void`	`onButtonQuery(org.zkoss.zk.ui.event.Event event)` Handles query button.
`void`	`onCancelEdit(org.zkoss.zk.ui.event.Event event)` Event handler for cancel edit event.
`void`	`onChangeDocumentSecurity(org.zkoss.zk.ui.event.Event event)` Event handler for change of document security.
`void`	`onDeleteSelected(org.zkoss.zk.ui.event.Event event)` Delete selected documents.
`void`	`onDocumentCheck(org.zkoss.zk.ui.event.Event event)` Checkout / checkin actual document.
`void`	`onDocumentRelease(org.zkoss.zk.ui.event.Event event)` Release actual document.
`void`	`onDownloadResultItem(org.zkoss.zk.ui.event.Event event)` Handle download document event.
`void`	`onEditContent(org.zkoss.zk.ui.event.Event event)` Handler for edit content event.
`void`	`onEditItemSelected(org.zkoss.zk.ui.event.Event event)` Edit an existing row.
`void`	`onEditSelected(org.zkoss.zk.ui.event.Event event)` Locks the selected row.
`void`	`onEditStructure(org.zkoss.zk.ui.event.Event event)` Handles event to edit a document's structure.
`void`	`onExport(org.zkoss.zk.ui.event.Event event)` Export current result.
`void`	`onIndexChange(org.zkoss.zk.ui.event.Event event)` Perform a query based on a document selected by another view.
`void`	`onLaunchWorkflow(org.zkoss.zk.ui.event.Event event)` Launch an workflow after user selection.
`void`	`onNavigationFolder(org.zkoss.zk.ui.event.Event event)` Handle navigation folder event.
`void`	`onNewSelected(org.zkoss.zk.ui.event.Event event)` Creates a new row.
`void`	`onPrintDocuments(org.zkoss.zk.ui.event.Event event)` Print selected documents.
`void`	`onRefresh(org.zkoss.zk.ui.event.Event event)` Refresh the view.
`void`	`onResetGui(org.zkoss.zk.ui.event.Event event)` Handler for reset ui event.
`void`	`onSaveDoc(org.zkoss.zk.ui.event.Event event)` Event handler for save document event.
`void`	`onSelectDDC(org.zkoss.zk.ui.event.Event event)` Handle DDC select event.
`void`	`onSendMailResultItem(org.zkoss.zk.ui.event.Event event)` Handle send documents as mail event.
`void`	`onStartWorkflow(org.zkoss.zk.ui.event.Event event)` Start workflow.
`void`	`onUnDeleteSelected(org.zkoss.zk.ui.event.Event event)` Undelete selected documents.
`void`	`onUploadSuccess(org.zkoss.zk.ui.event.Event event)` Handles upload success events.
`void`	`onWorkflowAction(org.zkoss.zk.ui.event.Event event)` Performs a workflow action.
`void`	`onWorkflowComment(org.zkoss.zk.ui.event.Event event)` Handle workflow comment event.
`void`	`performQuery(com.saperion.rmi.SaQueryInfo query)` Performs execution of the given query.
`void`	`refresh(boolean newQuery)` Refreshes the result list.
`void`	`releaseLocks()` Unlocks all previously locked documents.
`void`	`reset()` Reset view.
`void`	`selectFirst()` Selects the first valid row.
`void`	`selectLast()` Selects the last valid row.
`void`	`selectNext()` Selects the next row.
`void`	`selectPrevious()` Selects the previous row.
`void`	`setAllowed(String value)`
`void`	`setCustomSortSequences(Map<String,SortDirection> sortSequences)` Sets custom sort sequences for the specified column names.
`void`	`setDefaultButtonType(ResultSetView.DefaultButtonType defaultButton)` Sets the default type of button to be shown for each item in result list.
`void`	`setDefaultMenu(boolean value)`
`void`	`setDocumentRead(DraggableListItem item)` Deprecated. use `setDocumentRead(ResultListItem)` instead. Will be removed in 8.1.
`void`	`setDocumentRead(ResultListItem item)` Sets the specified item's state to 'read' without creating a new revision.
`void`	`setDocumentUnread(DraggableListItem item)` Deprecated. use `setDocumentUnread(ResultListItem)` instead. Will be removed in 8.1.
`void`	`setDocumentUnread(ResultListItem item)` Sets the specified item's state to 'unread' without creating a new revision.
`void`	`setExportEnabled(boolean enabled)` Enables or disables the export button.
`void`	`setFieldsToDisplay(String fields)`
`void`	`setFilterViewShown(boolean shown)` Enables or disables the filter view.
`void`	`setFormName(String name)`
`void`	`setHeaderAlignments(String alignments)` Sets the alignments of the headers.
`void`	`setHeaderNames(String names)` Sets the names of the column headers from left to right.
`void`	`setHeaderWidths(String widths)` Sets the widths of the headers.
`void`	`setPageSize(int size)` Sets the page size of the list.
`void`	`setRemoveMenuItemList(List<MenuItemKey> removeList, boolean multi)` Set menu items for removing.
`void`	`setResultColumns(Map<String,ResultSetColumn> resultColumns)` Sets the columns for the result list.
`void`	`setResultListClass(Class<? extends ResultList> clazz)` Sets the class that will be used for the internal `ResultList`.
`void`	`setSaveFavoriteEnabled(boolean enabled)` Sets the saveFavoriteEnabled parameter.
`void`	`setSaveLayout(boolean save)` Enables or disabled saving of the layout.
`void`	`setSearchMode(SearchMode mode)` Sets the search-mode.
`void`	`setSelectedIndex(int index)` Moves the selected index of the result list to the specified position.
`void`	`setSelectQuery(String query)` Setter for selectQuery attribute to be used in zul.
`void`	`setSelectWfQuery(String query, boolean perform)` Setter for selectQuery attribute to be used in zul.
`void`	`setSimpleMode(boolean simpleMode)` Sets the simple mode parameter.
`void`	`setSortingDirections(String directions)` Sets the sorting direction for each column from left to right.
`void`	`setTitle(String titleString)` Sets the title.
`void`	`updateListItem(ResultListItem item)` Updates the specified item in the list.

Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getDefinition, getDesktop, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getShadowVariable, getShadowVariable, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, query, queryAll, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride

Methods inherited from interface org.zkoss.zk.ui.ext.Scope
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

Methods inherited from interface com.saperion.ngc.events.EventChildHandler
postAddLinkEvent, postAddToFavoritesEvent, postCancelSelectedEvent, postChangeDocumentSecurityEvent, postChangeFolderSecurityEvent, postDeleteSelectedEvent, postDisplayPopupEvent, postDisplayPopupEvent, postDisplayResultItemEvent, postDisplayResultItemEvent, postDocumentCheckEvent, postDocumentFilingEvent, postDocumentFilingEvent, postDocumentReleaseEvent, postDownloadResultItemEvent, postEditContentEvent, postEditItemSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditStructureEvent, postFieldChangeEvent, postFileActionEvent, postFileActionEvent, postFormButtonEvent, postIndexResultItemEvent, postLaunchWorkflowEvent, postLockDocumentEvent, postLogonEvent, postLogonEvent, postNavigationFolderEvent, postNavigationFormEvent, postNavigationFormEvent, postNavigationWebpartEvent, postNewSelectedEvent, postOpenMaskEvent, postPrintDocumentEvent, postQueryFavoriteEvent, postRefreshEvent, postResetGuiEvent, postResultFieldEvent, postSaveDocumentEvent, postSaveDocumentEvent, postSelectTreeItemEvent, postSendMailResultItemEvent, postStartWorkflowEvent, postTabSelectedEvent, postUnDeleteSelectedEvent, postUploadDocumentEvent, postUploadSuccessEvent, postWorkflowActionEvent, postWorkflowCommentEvent

Methods inherited from interface com.saperion.ngc.events.LogEventChildHandler
postErrorLogEvent, postErrorLogEvent, postInfoLogEvent, postInfoLogEvent, postWarningLogEvent, postWarningLogEvent

Methods inherited from interface com.saperion.ngc.events.EventChild
getEventtarget, setEventtarget

- Field Detail
  - RSS_BUTTONEDIT
```
static final int RSS_BUTTONEDIT
```
    ResStyle bitmask entry for edit-button.
    
    See Also:
    
    Constant Field Values
  - RSS_BUTTONPRINT
```
static final int RSS_BUTTONPRINT
```
    ResStyle bitmask entry for print-button.
    
    See Also:
    
    Constant Field Values
  - RSS_BUTTONDELETE
```
static final int RSS_BUTTONDELETE
```
    ResStyle bitmask entry for delete-button.
    
    See Also:
    
    Constant Field Values
  - RSS_BUTTONINDEX
```
static final int RSS_BUTTONINDEX
```
    ResStyle bitmask entry for index-button.
    
    See Also:
    
    Constant Field Values
  - RSS_BUTTONSAVE
```
static final int RSS_BUTTONSAVE
```
    ResStyle bitmask entry for save-button.
    
    See Also:
    
    Constant Field Values
  - RSS_BUTTONNEW
```
static final int RSS_BUTTONNEW
```
    ResStyle bitmask entry for new-button.
    
    See Also:
    
    Constant Field Values
  - RSS_RESTRICTCURSOR
```
static final int RSS_RESTRICTCURSOR
```
    ResStyle bitmask entry for restrict-cursor-option.
    
    See Also:
    
    Constant Field Values
  - RSS_BUTTONVIEW
```
static final int RSS_BUTTONVIEW
```
    ResStyle bitmask entry for view-button.
    
    See Also:
    
    Constant Field Values
  - RSS_OUTLINE
```
static final int RSS_OUTLINE
```
    ResStyle bitmask entry for outliner-view.
    
    See Also:
    
    Constant Field Values
  - RSS_CONDITION
```
static final int RSS_CONDITION
```
    ResStyle bitmask entry for condition-option.
    
    See Also:
    
    Constant Field Values
  - RSS_SINGLECLICK
```
static final int RSS_SINGLECLICK
```
    ResStyle bitmask entry for singleclick-option.
    
    See Also:
    
    Constant Field Values
  - RSS_BUTTONSECURITY
```
static final int RSS_BUTTONSECURITY
```
    ResStyle bitmask entry for security-button.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_RIGHTS_MASK
```
static final int DEFAULT_RIGHTS_MASK
```
    Bitmask with default menu entries enabled.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUTTON_EDIT_ID
```
static final int DEFAULT_BUTTON_EDIT_ID
```
    QBE id for default button edit.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUTTON_PRINT_ID
```
static final int DEFAULT_BUTTON_PRINT_ID
```
    QBE id for default button print.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUTTON_DELETE_ID
```
static final int DEFAULT_BUTTON_DELETE_ID
```
    QBE id for default button delete.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUTTON_INDEX_ID
```
static final int DEFAULT_BUTTON_INDEX_ID
```
    QBE id for default button index.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUTTON_SAVE_ID
```
static final int DEFAULT_BUTTON_SAVE_ID
```
    QBE id for default button save.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUTTON_VIEW_ID
```
static final int DEFAULT_BUTTON_VIEW_ID
```
    QBE id for default button view.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BUTTON_SECURITY_ID
```
static final int DEFAULT_BUTTON_SECURITY_ID
```
    QBE id for default button security.
    
    See Also:
    
    Constant Field Values
  - MAX_COUNT_FOR_CLIENTSIDE_FUNCTIONS
```
static final int MAX_COUNT_FOR_CLIENTSIDE_FUNCTIONS
```
    Maximum amount of items allowed in a result to use client side functions.
    
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME
```
static final String DISPLAY_NAME
```
    Attribute name for display name.
    
    See Also:
    
    Constant Field Values
  - DATABASE_NAME
```
static final String DATABASE_NAME
```
    Attribute name for database name.
    
    See Also:
    
    Constant Field Values
  - FILTER_COLS
```
static final int FILTER_COLS
```
    Length of the filter box.
    
    See Also:
    
    Constant Field Values
  - FILTER_TIMEOUT
```
static final int FILTER_TIMEOUT
```
    Timeout for filter operation.
    
    See Also:
    
    Constant Field Values
  - CONTEXT_TIMEOUT
```
static final int CONTEXT_TIMEOUT
```
    Timeout for context menus.
    
    See Also:
    
    Constant Field Values
  - WF_BOX_ID
```
static final String WF_BOX_ID
```
    Name of box id property.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - clearResultSet
```
void clearResultSet()
```
    Clears the result set.
  - initializePaging
```
void initializePaging(ResultPaging paging)
```
    Initialize paging options.
    
    Parameters:
    
    paging - paging
  - reset
```
void reset()
```
    Reset view.
  - releaseLocks
```
void releaseLocks()
```
    Unlocks all previously locked documents.
  - setSelectedIndex
```
void setSelectedIndex(int index)
```
    Moves the selected index of the result list to the specified position. If the specified position is not available, the method has no effect.
    
    Parameters:
    
    index - new index to select
  - getSelectedIndex
```
int getSelectedIndex()
```
    Returns the currently selected index.
    
    Returns:
    
    the currently selected index
  - getOriginalItemIndex
```
int getOriginalItemIndex()
```
    Returns the original index of the currently selected item or -1 if no item is selected.
    
    Returns:
    
    item index
  - onSelectDDC
```
void onSelectDDC(org.zkoss.zk.ui.event.Event event)
```
    Handle DDC select event.
    
    Parameters:
    
    event - Event
  - onDownloadResultItem
```
void onDownloadResultItem(org.zkoss.zk.ui.event.Event event)
```
    Handle download document event.
    
    Parameters:
    
    event - Event
  - onSendMailResultItem
```
void onSendMailResultItem(org.zkoss.zk.ui.event.Event event)
```
    Handle send documents as mail event.
    
    Parameters:
    
    event - Event
  - onNavigationFolder
```
void onNavigationFolder(org.zkoss.zk.ui.event.Event event)
```
    Handle navigation folder event.
    
    Parameters:
    
    event - Event
  - onButtonQuery
```
void onButtonQuery(org.zkoss.zk.ui.event.Event event)
```
    Handles query button.
    
    Parameters:
    
    event - Events
  - onEditSelected
```
void onEditSelected(org.zkoss.zk.ui.event.Event event)
```
    Locks the selected row.
    
    Parameters:
    
    event - Event
  - onNewSelected
```
void onNewSelected(org.zkoss.zk.ui.event.Event event)
```
    Creates a new row.
    
    Parameters:
    
    event - Event
  - onEditItemSelected
```
void onEditItemSelected(org.zkoss.zk.ui.event.Event event)
```
    Edit an existing row.
    
    Parameters:
    
    event - Event
  - onRefresh
```
void onRefresh(org.zkoss.zk.ui.event.Event event)
```
    Refresh the view.
    
    Parameters:
    
    event - Event
  - onStartWorkflow
```
void onStartWorkflow(org.zkoss.zk.ui.event.Event event)
```
    Start workflow.
    
    Parameters:
    
    event - Event
  - onLaunchWorkflow
```
void onLaunchWorkflow(org.zkoss.zk.ui.event.Event event)
```
    Launch an workflow after user selection.
    
    Parameters:
    
    event - Event
  - onWorkflowAction
```
void onWorkflowAction(org.zkoss.zk.ui.event.Event event)
```
    Performs a workflow action.
    
    Parameters:
    
    event - Event
  - onWorkflowComment
```
void onWorkflowComment(org.zkoss.zk.ui.event.Event event)
```
    Handle workflow comment event.
    
    Parameters:
    
    event - Event
  - onIndexChange
```
void onIndexChange(org.zkoss.zk.ui.event.Event event)
```
    Perform a query based on a document selected by another view.
    
    Parameters:
    
    event - Event
  - onResetGui
```
void onResetGui(org.zkoss.zk.ui.event.Event event)
```
    Handler for reset ui event.
    
    Parameters:
    
    event - ZK event
  - onEditContent
```
void onEditContent(org.zkoss.zk.ui.event.Event event)
```
    Handler for edit content event.
    
    Parameters:
    
    event - ZK event
  - onDeleteSelected
```
void onDeleteSelected(org.zkoss.zk.ui.event.Event event)
```
    Delete selected documents.
    
    Parameters:
    
    event - event
  - onUnDeleteSelected
```
void onUnDeleteSelected(org.zkoss.zk.ui.event.Event event)
```
    Undelete selected documents.
    
    Parameters:
    
    event - event
  - onDocumentCheck
```
void onDocumentCheck(org.zkoss.zk.ui.event.Event event)
```
    Checkout / checkin actual document.
    
    Parameters:
    
    event - Event
  - onDocumentRelease
```
void onDocumentRelease(org.zkoss.zk.ui.event.Event event)
```
    Release actual document.
    
    Parameters:
    
    event - Event
  - onPrintDocuments
```
void onPrintDocuments(org.zkoss.zk.ui.event.Event event)
```
    Print selected documents.
    
    Parameters:
    
    event - Event
  - onExport
```
void onExport(org.zkoss.zk.ui.event.Event event)
```
    Export current result.
    
    Parameters:
    
    event - Event
  - onEditStructure
```
void onEditStructure(org.zkoss.zk.ui.event.Event event)
```
    Handles event to edit a document's structure.
    
    Parameters:
    
    event - event
  - onUploadSuccess
```
void onUploadSuccess(org.zkoss.zk.ui.event.Event event)
```
    Handles upload success events.
    
    Parameters:
    
    event - event
  - setSelectQuery
```
void setSelectQuery(String query)
```
    Setter for selectQuery attribute to be used in zul. Performs execution of the given query.
    
    Parameters:
    
    query - Query string
  - setSelectWfQuery
```
void setSelectWfQuery(String query,
                      boolean perform)
```
    Setter for selectQuery attribute to be used in zul. Performs execution of the given query.
    
    Parameters:
    
    query - Query string
    
    perform - True for perform immediately
  - performQuery
```
void performQuery(com.saperion.rmi.SaQueryInfo query)
```
    Performs execution of the given query.
    
    Parameters:
    
    query - query info
  - getSelectQuery
```
String getSelectQuery()
```
    Returns:
    
    select query
  - getPageSize
```
int getPageSize()
```
    Returns:
    
    the page size
  - setPageSize
```
void setPageSize(int size)
```
    Sets the page size of the list.
    
    Parameters:
    
    size - page size
  - isFilterViewShown
```
boolean isFilterViewShown()
```
    Returns:
    
    filter view shown
  - setFilterViewShown
```
void setFilterViewShown(boolean shown)
```
    Enables or disables the filter view.
    
    Parameters:
    
    shown - true if filter view should be shown
  - getFieldsToDisplay
```
String getFieldsToDisplay()
```
    Returns:
    
    the fieldsToDisplay
  - setFieldsToDisplay
```
void setFieldsToDisplay(String fields)
```
    Parameters:
    
    fields - the fieldsToDisplay to set
  - getSortingDirections
```
String getSortingDirections()
```
    Returns:
    
    sorting directions
  - setSortingDirections
```
void setSortingDirections(String directions)
```
    Sets the sorting direction for each column from left to right. Can only be set in combination with fieldsToDisplay.
    
    Parameters:
    
    directions - Comma-separated list of directions. Possible values: 'ascending', 'descending', 'natural', 'disabled'.
  - getHeaderNames
```
String getHeaderNames()
```
    Returns:
    
    the preset header names
  - setHeaderNames
```
void setHeaderNames(String names)
```
    Sets the names of the column headers from left to right. Can only be set in combination with fieldsToDisplay.
    
    Parameters:
    
    names - header names
  - getHeaderAlignments
```
String getHeaderAlignments()
```
    Returns:
    
    header alignments
  - setHeaderAlignments
```
void setHeaderAlignments(String alignments)
```
    Sets the alignments of the headers. Can only be set in combination with fieldsToDisplay.
    
    Parameters:
    
    alignments - alignments. Possible values: 'right', 'left', 'center'.
  - getHeaderWidths
```
String getHeaderWidths()
```
    Returns:
    
    header widths
  - setHeaderWidths
```
void setHeaderWidths(String widths)
```
    Sets the widths of the headers. Can only be used in combination with fieldsToDisplay.
    
    Parameters:
    
    widths - widths When an invalid value was found
  - getSelectedItems
```
@Deprecated
Set<DraggableListItem> getSelectedItems()
```
    Deprecated. use getSelectedListItems() instead. Will be removed in 8.1.
    
    Returns all selected items.
    
    Returns:
    
    selected items
  - getSelectedItem
```
@Deprecated
DraggableListItem getSelectedItem()
```
    Deprecated. use getSelectedListItem() instead. Will be removed in 8.1.
    
    Returns the selected item.
    
    Returns:
    
    selected item
  - getSelectedListItems
```
Set<ResultListItem> getSelectedListItems()
```
    Returns all selected items.
    
    Returns:
    
    selected items
  - getSelectedListItem
```
ResultListItem getSelectedListItem()
```
    Returns the selected item.
    
    Returns:
    
    selected item
  - getSelectedIds
```
List<DocumentId> getSelectedIds()
```
    Returns the IDs of the selected documents.
    
    Returns:
    
    List of document ids
  - onCancelEdit
```
void onCancelEdit(org.zkoss.zk.ui.event.Event event)
```
    Event handler for cancel edit event.
    
    Parameters:
    
    event - event
  - onSaveDoc
```
void onSaveDoc(org.zkoss.zk.ui.event.Event event)
```
    Event handler for save document event.
    
    Parameters:
    
    event - event
  - onChangeDocumentSecurity
```
void onChangeDocumentSecurity(org.zkoss.zk.ui.event.Event event)
```
    Event handler for change of document security.
    
    Parameters:
    
    event - event
  - setResultColumns
```
void setResultColumns(Map<String,ResultSetColumn> resultColumns)
```
    Sets the columns for the result list.
    
    Parameters:
    
    resultColumns - columns
  - setSimpleMode
```
void setSimpleMode(boolean simpleMode)
```
    Sets the simple mode parameter.
    
    Parameters:
    
    simpleMode - parameter value
  - isSimpleMode
```
boolean isSimpleMode()
```
    Returns:
    
    simple mode parameter value
  - setFormName
```
void setFormName(String name)
```
    Parameters:
    
    name - Form name
  - getFormName
```
String getFormName()
```
    Returns:
    
    Form name
  - setSaveFavoriteEnabled
```
void setSaveFavoriteEnabled(boolean enabled)
```
    Sets the saveFavoriteEnabled parameter.
    
    Parameters:
    
    enabled - value
  - isSaveFavoriteEnabled
```
boolean isSaveFavoriteEnabled()
```
    Returns:
    
    saveFavoriteEnabled parameter
  - setExportEnabled
```
void setExportEnabled(boolean enabled)
```
    Enables or disables the export button.
    
    Parameters:
    
    enabled - enabled or not
  - isExportEnabled
```
boolean isExportEnabled()
```
    Returns:
    
    whether export is enabled or not
  - isAutoSearch
```
boolean isAutoSearch()
```
    Returns:
    
    Auto search on.
  - setTitle
```
void setTitle(String titleString)
```
    Sets the title. Used in iForms to display frame title.
    
    Parameters:
    
    titleString - title string
  - addCustomMenuItem
```
void addCustomMenuItem(org.zkoss.zul.Menuitem item,
                       boolean multi)
```
    Adds a custom menu item. If multi is true, the menu item will be added to the single and multi selection menus.
    
    Parameters:
    
    item - the item
    
    multi - set to true if the item should be available for multi selection
  - getCustomMenuItems
```
List<org.zkoss.zul.Menuitem> getCustomMenuItems(boolean multi)
```
    Returns the custom menu items.
    
    Parameters:
    
    multi - if true, the menu items returned can be used with multi selection
    
    Returns:
    
    map with label/menuitem pairs
  - setRemoveMenuItemList
```
void setRemoveMenuItemList(List<MenuItemKey> removeList,
                           boolean multi)
```
    Set menu items for removing.
    
    Parameters:
    
    removeList - List of items.
    
    multi - True for multiselect
  - getRemoveMenuItemList
```
List<MenuItemKey> getRemoveMenuItemList(boolean multi)
```
    Reads the list of remove menu items.
    
    Parameters:
    
    multi - True for multiselect
    
    Returns:
    
    list of remove menu items
  - getSelectedRows
```
List<ResultProperties> getSelectedRows()
```
    Returns a list containing the properties of the selected rows. If no row is selected, an empty list is returned.
    
    Returns:
    
    list of properties of the selected rows
  - getAllRows
```
List<ResultProperties> getAllRows()
```
    Returns a list containing the properties of all rows.
    
    Returns:
    
    list of properties of all rows
  - getParentForm
```
IntelligentFormView getParentForm()
```
    Returns the parent form or null if this field is not part of a form.
    
    Returns:
    
    parent form or null
  - getResultSetList
```
ResultList getResultSetList()
```
    Returns the ResultList used in this ResultSetView.
    
    Returns:
    
    ResultList used in this ResultSetView
  - getResultType
```
com.saperion.ngc.iform.xml.ResultType getResultType()
```
    Returns the ResultType that contains the properties of this ResultSetView as defined in the QBE-form.
    
    Returns:
    
    the ResultType of this ResultSetView
  - getAllowed
```
String getAllowed()
```
    Returns:
    
    Returns all allowed features.
  - setAllowed
```
void setAllowed(String value)
```
    Parameters:
    
    value - Comma separated list of allowed features. One of: EDIT, DELETE, INDEX, SAVE, NEW, VIEW, SECURITY
  - getDefaultMenu
```
boolean getDefaultMenu()
```
    Returns:
    
    True, if default menu switched on.
  - setDefaultMenu
```
void setDefaultMenu(boolean value)
```
    Parameters:
    
    value - True for switched on default menu.
  - addCustomMenu
```
void addCustomMenu(org.zkoss.zul.Menu menu,
                   boolean multi)
```
    Adds a custom menu. If multi is true, the menu item will be added to the single and multi selection menus.
    
    Parameters:
    
    menu - the menu
    
    multi - set to true if the menu should be available for multi selection
  - getCustomMenus
```
List<org.zkoss.zul.Menu> getCustomMenus(boolean multi)
```
    Returns the custom menus.
    
    Parameters:
    
    multi - if true, the menus returned can be used with multi selection
    
    Returns:
    
    list of menus
  - getContextMenuPopup
```
org.zkoss.zul.Menupopup getContextMenuPopup()
```
    Returns the popup of the context menu. Note that the popup is replaced each time the list is rendered. To modify the menu, use addCustomMenu or addCustomMenuItem instead.
    
    Returns:
    
    the context menu popup of the result list
    
    See Also:
    
    addCustomMenu(Menu, boolean), addCustomMenuItem(Menuitem, boolean)
  - refresh
```
void refresh(boolean newQuery)
```
    Refreshes the result list.
    
    Parameters:
    
    newQuery - if true, the query will be executed on the backend system again
  - updateListItem
```
void updateListItem(ResultListItem item)
```
    Updates the specified item in the list. The other items will remain as they are. The list will not automatically scroll to updated item or activate the page that contains the specified item. This method throws an IllegalArgumentException when the specified item is not contained in the current query-result.
    
    Parameters:
    
    item - the item to be updated
  - setDefaultButtonType
```
void setDefaultButtonType(ResultSetView.DefaultButtonType defaultButton)
```
    Sets the default type of button to be shown for each item in result list.
    
    Parameters:
    
    defaultButton - default button type to be set
  - getDefaultButtonType
```
ResultSetView.DefaultButtonType getDefaultButtonType()
```
    Returns:
    
    the default type of button to be shown for each item in result list.
  - getIndexMask
```
String getIndexMask()
```
    Returns:
    
    the index mask defined in the definition of this ResultSetView
  - getNumberOfIndexes
```
int getNumberOfIndexes()
```
    Returns the number of items in this list.
    
    Returns:
    
    item count in result-list.
  - selectNext
```
void selectNext()
```
    Selects the next row.
  - selectPrevious
```
void selectPrevious()
```
    Selects the previous row.
  - selectFirst
```
void selectFirst()
```
    Selects the first valid row.
  - selectLast
```
void selectLast()
```
    Selects the last valid row.
  - setSaveLayout
```
void setSaveLayout(boolean save)
```
    Enables or disabled saving of the layout.
    
    Parameters:
    
    save - true to enable, false to disable
  - isSaveLayout
```
boolean isSaveLayout()
```
    Checks if save layout is enabled.
    
    Returns:
    
    true, if enabled, false if not.
  - deleteConfiguration
```
void deleteConfiguration()
```
    Deletes the stored configuration of the columns (width and sort-direction).
  - setSearchMode
```
void setSearchMode(SearchMode mode)
```
    Sets the search-mode. See SearchMode for possible modes.
    
    Parameters:
    
    mode - the search mode to use
  - getSearchMode
```
SearchMode getSearchMode()
```
    Returns:
    
    the search mode currently in use
  - export
```
void export()
```
    Exports the current query result. A settings-dialog is shown to let the user decide the format, filename and columns for the export.
  - export
```
void export(Map<String,String> columnsToExport,
            ResultSetView.ExportFormat format,
            String filename)
```
    Exports the current query result. No settings-dialog will be shown.
    
    Parameters:
    
    columnsToExport - columns to be exported. The map contains the upper-case column names as in the database as keys and the desired display-names of the columns as values.
    
    format - the format to export to
    
    filename - the name of the resulting file
  - getTotalSize
```
int getTotalSize()
```
    Returns the total size of the last query result.
    
    Returns:
    
    total size of result
  - setDocumentRead
```
@Deprecated
void setDocumentRead(DraggableListItem item)
```
    Deprecated. use setDocumentRead(ResultListItem) instead. Will be removed in 8.1.
    
    Sets the specified item's state to 'read' without creating a new revision.
    
    Parameters:
    
    item - item to change
  - setDocumentUnread
```
@Deprecated
void setDocumentUnread(DraggableListItem item)
```
    Deprecated. use setDocumentUnread(ResultListItem) instead. Will be removed in 8.1.
    
    Sets the specified item's state to 'unread' without creating a new revision.
    
    Parameters:
    
    item - item to change
  - setDocumentRead
```
void setDocumentRead(ResultListItem item)
```
    Sets the specified item's state to 'read' without creating a new revision.
    
    Parameters:
    
    item - item to change
  - setDocumentUnread
```
void setDocumentUnread(ResultListItem item)
```
    Sets the specified item's state to 'unread' without creating a new revision.
    
    Parameters:
    
    item - item to change
  - addCustomCondition
```
void addCustomCondition(FieldResultBean condition)
```
    Adds a condition that will be used each time this ResultSetView performs a query.
    
    Parameters:
    
    condition - a FieldResultBean or a CustomConditionBean with the condition
  - getCustomConditions
```
List<FieldResultBean> getCustomConditions()
```
    Returns:
    
    list of all custom conditions that were added by addCustomCondition(FieldResultBean). The returned list can be modified.
  - setResultListClass
```
void setResultListClass(Class<? extends ResultList> clazz)
```
    Sets the class that will be used for the internal ResultList. The default is ResultListImpl. The class must have a constructor with no arguments.
    
    Parameters:
    
    clazz - class to be used
  - setCustomSortSequences
```
void setCustomSortSequences(Map<String,SortDirection> sortSequences)
```
    Sets custom sort sequences for the specified column names. These sort sequences will overwrite the sort sequences selected by the user in the UI.
    
    Parameters:
    
    sortSequences - a map that maps the database-name of a column with a SortDirection
  - getCustomSortSequences
```
Map<String,SortDirection> getCustomSortSequences()
```
    Returns:
    
    the custom sort sequences set by setCustomSortSequences(Map). If no custom sort sequences were set, this method returns an empty map.
  - getPropertyConverter
```
PropertyToStringConverter getPropertyConverter()
```
    Returns the converter that is used to convert SaPropertyValue instances to strings. The converter is initialized with the current locale and the DDC used by this ResultSetView.
    
    Returns:
    
    the property converter used by this ResultSetView

Interface ResultSetView

Nested Class Summary

Field Summary

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

Fields inherited from interface com.saperion.ngc.events.EventChild

Method Summary

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

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

Methods inherited from interface com.saperion.ngc.events.EventChildHandler

Methods inherited from interface com.saperion.ngc.events.LogEventChildHandler

Methods inherited from interface com.saperion.ngc.events.EventChild

Field Detail

RSS_BUTTONEDIT

RSS_BUTTONPRINT

RSS_BUTTONDELETE

RSS_BUTTONINDEX

RSS_BUTTONSAVE

RSS_BUTTONNEW

RSS_RESTRICTCURSOR

RSS_BUTTONVIEW

RSS_OUTLINE

RSS_CONDITION

RSS_SINGLECLICK

RSS_BUTTONSECURITY

DEFAULT_RIGHTS_MASK

DEFAULT_BUTTON_EDIT_ID

DEFAULT_BUTTON_PRINT_ID

DEFAULT_BUTTON_DELETE_ID

DEFAULT_BUTTON_INDEX_ID

DEFAULT_BUTTON_SAVE_ID

DEFAULT_BUTTON_VIEW_ID

DEFAULT_BUTTON_SECURITY_ID

MAX_COUNT_FOR_CLIENTSIDE_FUNCTIONS

DISPLAY_NAME

DATABASE_NAME

FILTER_COLS

FILTER_TIMEOUT

CONTEXT_TIMEOUT

WF_BOX_ID

Method Detail

clearResultSet

initializePaging

reset

releaseLocks

setSelectedIndex

getSelectedIndex

getOriginalItemIndex

onSelectDDC

onDownloadResultItem

onSendMailResultItem

onNavigationFolder

onButtonQuery

onEditSelected

onNewSelected

onEditItemSelected

onRefresh

onStartWorkflow

onLaunchWorkflow

onWorkflowAction

onWorkflowComment

onIndexChange

onResetGui

onEditContent

onDeleteSelected

onUnDeleteSelected

onDocumentCheck

onDocumentRelease

onPrintDocuments

onExport

onEditStructure

onUploadSuccess

setSelectQuery

setSelectWfQuery

performQuery

getSelectQuery

getPageSize

setPageSize

isFilterViewShown

setFilterViewShown

getFieldsToDisplay