public class ResultSetViewImpl extends BaseWindow implements ResultSetView
EventChild.ON_INDEX_RESULTITEM
when the user selects an item in the list. Event is
an instance of IndexResultItemEvent
.
EventChild.ON_ITEM_DOUBLECLICK
when the user double-clicks on an item in the list.
Event is an instance of ItemDoubleClickEvent
.
EventChild.ON_AFTER_QUERY
when a query was performed. Event is an instance of
Event
.
Modifier and Type | Class and Description |
---|---|
static class |
ResultSetViewImpl.ViewMode
Enumeration for view modes.
|
org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl
org.zkoss.zk.ui.AbstractComponent.Children
ResultSetView.DefaultButtonType, ResultSetView.ExportFormat
CONTEXT_TIMEOUT, DATABASE_NAME, DEFAULT_BUTTON_DELETE_ID, DEFAULT_BUTTON_EDIT_ID, DEFAULT_BUTTON_INDEX_ID, DEFAULT_BUTTON_PRINT_ID, DEFAULT_BUTTON_SAVE_ID, DEFAULT_BUTTON_SECURITY_ID, DEFAULT_BUTTON_VIEW_ID, DEFAULT_RIGHTS_MASK, DISPLAY_NAME, FILTER_COLS, FILTER_TIMEOUT, MAX_COUNT_FOR_CLIENTSIDE_FUNCTIONS, RSS_BUTTONDELETE, RSS_BUTTONEDIT, RSS_BUTTONINDEX, RSS_BUTTONNEW, RSS_BUTTONPRINT, RSS_BUTTONSAVE, RSS_BUTTONSECURITY, RSS_BUTTONVIEW, RSS_CONDITION, RSS_OUTLINE, RSS_RESTRICTCURSOR, RSS_SINGLECLICK, WF_BOX_ID
APPLICATION_SCOPE, COMPONENT_SCOPE, DESKTOP_SCOPE, PAGE_SCOPE, REQUEST_SCOPE, SESSION_SCOPE, SPACE_SCOPE
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
Constructor and Description |
---|
ResultSetViewImpl()
Constructor.
|
ResultSetViewImpl(boolean showTitleArea)
Constructor for use in LookupPopup.
|
ResultSetViewImpl(com.saperion.ngc.iform.xml.ResultType definition,
boolean stretch,
String maskName,
com.saperion.ngc.iform.xml.PosType panePos,
String ddc)
Constructor for iForm use.
|
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 |
afterSelect(boolean focus)
Performs the necessary actions after an item was selected.
|
void |
clearResultSet()
Removes all child-components from ResultSetView-Center.
|
void |
deleteConfiguration()
Deletes the stored configuration of the columns (width and sort-direction).
|
void |
doSort()
Sorts the current result.
|
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.Center |
getCenter() |
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() |
List<DocumentVersionInfo> |
getDocumentVersions(DocumentId id) |
String |
getFieldsToDisplay() |
FolderId |
getFileParent() |
String |
getFormName() |
String |
getHeaderAlignments() |
Set<org.zkoss.zul.Menupopup> |
getHeaderMenuPopups() |
String |
getHeaderNames() |
String |
getHeaderWidths() |
String |
getIndexMask() |
String |
getMaskName()
get the MaskName .
|
int |
getMaxRecords()
Gets maximum number of records for the result set.
|
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. |
ResultSetViewFilterArea |
getResultSetViewFilterArea() |
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.
|
ResultSetViewImpl.ViewMode |
getViewMode() |
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)
Fires onButtonQuery-event for executing a database-query.
|
void |
onCancelEdit(org.zkoss.zk.ui.event.Event event)
Fires onCancelEdit-event for cancel editing selected items in combo box.
|
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)
Fires onDownloadResultItem-event for downloading items (containing in event) from server.
|
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)
Fires onEditSelected-event for editing selected items in combo box.
|
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)
Fires onNavigationFolder-event for showing folder documents.
|
void |
onNewSelected(org.zkoss.zk.ui.event.Event event)
Creates a new row.
|
void |
onPageAttached(org.zkoss.zk.ui.Page newpage,
org.zkoss.zk.ui.Page oldpage) |
void |
onPageDetached(org.zkoss.zk.ui.Page page) |
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)
Fires a SelectDDCEvent.
|
void |
onSendMailResultItem(org.zkoss.zk.ui.event.Event event)
Fires onSendMailResultItem-event for sending items (contained in event) as mail from server.
|
void |
onStartWorkflow(org.zkoss.zk.ui.event.Event event)
Fires onStartWorkflow-event for starting the workflow for the selected document.
|
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)
Performs a workflow action.
|
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 documents.
|
void |
reset()
Removes the ResultSetList from main-center.
|
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 fieldstodisplay) |
void |
setFileParent(FolderId parent)
Sets the folder this result list is using.
|
void |
setFilterViewShown(boolean showFilterView)
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 |
setLookupMode()
Set the list to lookup mode.
|
void |
setMaxRecords(int maxRecords)
Sets maximum number of records for the result set.
|
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 |
setSelectLookupMode()
Set the list to select lookup mode.
|
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 mode)
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 |
setVisibleColumns(Set<String> columns) |
void |
updateListItem(ResultListItem item)
Updates the specified item in the list.
|
getEventtarget, getMainWindow, postAddLinkEvent, postAddToFavoritesEvent, postCancelSelectedEvent, postChangeDocumentSecurityEvent, postChangeFolderSecurityEvent, postDeleteSelectedEvent, postDisplayPopupEvent, postDisplayPopupEvent, postDisplayResultItemEvent, postDisplayResultItemEvent, postDocumentCheckEvent, postDocumentFilingEvent, postDocumentFilingEvent, postDocumentReleaseEvent, postDownloadResultItemEvent, postEditContentEvent, postEditItemSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditStructureEvent, postErrorLogEvent, postErrorLogEvent, postFieldChangeEvent, postFileActionEvent, postFileActionEvent, postFormButtonEvent, postIndexResultItemEvent, postInfoLogEvent, postInfoLogEvent, postLaunchWorkflowEvent, postLockDocumentEvent, postLogonEvent, postLogonEvent, postNavigationFolderEvent, postNavigationFormEvent, postNavigationFormEvent, postNavigationWebpartEvent, postNewSelectedEvent, postOpenMaskEvent, postPrintDocumentEvent, postQueryFavoriteEvent, postRefreshEvent, postResetGuiEvent, postResultFieldEvent, postSaveDocumentEvent, postSaveDocumentEvent, postSelectTreeItemEvent, postSendMailResultItemEvent, postStartWorkflowEvent, postTabSelectedEvent, postUnDeleteSelectedEvent, postUploadDocumentEvent, postUploadSuccessEvent, postWarningLogEvent, postWarningLogEvent, postWorkflowActionEvent, postWorkflowCommentEvent, setEventtarget
beforeChildAdded, clone, doEmbedded, doHighlighted, doModal, doOverlapped, doPopup, getBorder, getCaption, getContentSclass, getContentStyle, getDefaultActionOnShow, getMinheight, getMinwidth, getMode, getModeType, getPosition, getTitle, getZclass, inEmbedded, inHighlighted, inModal, inOverlapped, inPopup, insertBefore, isClosable, isCollapsible, isMaximizable, isMaximized, isMinimizable, isMinimized, isShadow, isSizable, onChildRemoved, onClose, onModal, renderProperties, service, setBorder, setBorder, setClosable, setContentSclass, setContentStyle, setDefaultActionOnShow, setDraggable, setMaximizable, setMaximized, setMinheight, setMinimizable, setMinimized, setMinwidth, setMode, setMode, setMode, setPosition, setShadow, setSizable, setTopmost, setVisible
getContext, getCtrlKeys, getPopup, getPropertyAccess, getTooltip, setContext, setContext, setContextAttributes, setCtrlKeys, setPopup, setPopup, setPopupAttributes, setTooltip, setTooltip, setTooltipAttributes
addSclass, focus, getAction, getDraggable, getDroppable, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, removeSclass, removeSclass, setAction, setClass, setDroppable, setFocus, setHeight, setHeight0, setHeightDirectly, setHflex, setHflex0, setHflexDirectly, setLeft, setLeftDirectly, setRenderdefer, setSclass, setStyle, setTabindex, setTabindex, setTooltiptext, setTop, setTopDirectly, setVflex, setVflex0, setVflexDirectly, setWidth, setWidth0, setWidthDirectly, setZclass, setZindex, setZIndex, setZIndexDirectly
addAnnotation, addAnnotation, addCallback, addClientEvent, addEventHandler, addEventListener, addEventListener, addForward, addForward, addForward, addForward, addMoved, addRedrawCallback, addScopeListener, addShadowRoot, addShadowRootBefore, addSharedEventHandlerMap, appendChild, applyProperties, beforeChildRemoved, beforeParentChanged, detach, didActivate, didActivate, didDeserialize, didDeserialize, disableBindingAnnotation, disableClientUpdate, enableBindingAnnotation, getAnnotatedProperties, getAnnotatedPropertiesBy, getAnnotation, getAnnotation, getAnnotations, getAnnotations, getAnnotations, getAttribute, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getCallback, getChildren, getClientAttribute, getClientDataAttribute, getClientEvents, getDefaultMold, getDefinition, getDesktop, getEventHandler, getEventHandlerNames, getEventListenerMap, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRedrawCallback, getRoot, getShadowFellowIfAny, getShadowRoots, getShadowVariable, getShadowVariable, getShadowVariable0, getSpaceOwner, getSpecialRendererOutput, getStubonly, getSubBindingAnnotationCount, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttribute, hasAttributeOrFellow, hasBindingAnnotation, hasFellow, hasFellow, hasSubBindingAnnotation, invalidate, isChildable, isInvalidated, isListenerAvailable, isVisible, onChildAdded, onWrongValue, query, queryAll, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeCallback, removeChild, removeEventListener, removeForward, removeForward, removeRedrawCallback, removeScopeListener, removeShadowRoot, render, render, render, replace, response, response, response, service, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setSubBindingAnnotationCount, setTemplate, setVisibleDirectly, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdate, smartUpdateWidgetListener, smartUpdateWidgetOverride, toString, updateByClient, updateSubBindingAnnotationCount, willPassivate, willPassivate, willSerialize, willSerialize
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
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
addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute
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
postErrorLogEvent, postErrorLogEvent, postInfoLogEvent, postInfoLogEvent, postWarningLogEvent, postWarningLogEvent
getEventtarget, setEventtarget
public ResultSetViewImpl()
public ResultSetViewImpl(boolean showTitleArea)
showTitleArea
- whether to show the title area or not. Note that when the title area is disabled,
the favorite button and the filter-box are disabled, too.public ResultSetViewImpl(com.saperion.ngc.iform.xml.ResultType definition, boolean stretch, String maskName, com.saperion.ngc.iform.xml.PosType panePos, String ddc)
definition
- component definitionstretch
- true if the component should fill its containermaskName
- Mask namepanePos
- Pane positionddc
- DDC namepublic int getOriginalItemIndex()
ResultSetView
getOriginalItemIndex
in interface ResultSetView
ResultSetView.getOriginalItemIndex()
public org.zkoss.zul.Center getCenter()
public void doSort()
ResultList.getHeaderInformation()
.public final void clearResultSet()
clearResultSet
in interface ResultSetView
ResultSetView.clearResultSet()
public final void reset()
reset
in interface ResultSetView
ResultSetView.reset()
public void releaseLocks()
releaseLocks
in interface ResultSetView
ResultSetView.releaseLocks()
public void onSelectDDC(org.zkoss.zk.ui.event.Event event)
onSelectDDC
in interface ResultSetView
event
- the event contains the database to be selectResultSetView.onSelectDDC(org.zkoss.zk.ui.event.Event)
public void onDownloadResultItem(org.zkoss.zk.ui.event.Event event)
onDownloadResultItem
in interface ResultSetView
event
- EventResultSetView.onDownloadResultItem(org.zkoss.zk.ui.event.Event)
public void onSendMailResultItem(org.zkoss.zk.ui.event.Event event)
onSendMailResultItem
in interface ResultSetView
event
- EventResultSetView.onSendMailResultItem(org.zkoss.zk.ui.event.Event)
public void onNavigationFolder(org.zkoss.zk.ui.event.Event event)
onNavigationFolder
in interface ResultSetView
event
- - Event on Navigation Folder.ResultSetView.onNavigationFolder(org.zkoss.zk.ui.event.Event)
public void onButtonQuery(org.zkoss.zk.ui.event.Event event)
onButtonQuery
in interface ResultSetView
event
- EventsResultSetView.onButtonQuery(org.zkoss.zk.ui.event.Event)
public void onEditSelected(org.zkoss.zk.ui.event.Event event)
onEditSelected
in interface ResultSetView
event
- EventResultSetView.onEditSelected(org.zkoss.zk.ui.event.Event)
public void onCancelEdit(org.zkoss.zk.ui.event.Event event)
onCancelEdit
in interface ResultSetView
event
- eventResultSetView.onCancelEdit(org.zkoss.zk.ui.event.Event)
public void onEditStructure(org.zkoss.zk.ui.event.Event event)
onEditStructure
in interface ResultSetView
event
- eventResultSetView.onEditStructure(org.zkoss.zk.ui.event.Event)
public void selectNext()
selectNext
in interface ResultSetView
public void selectPrevious()
selectPrevious
in interface ResultSetView
public void selectFirst()
selectFirst
in interface ResultSetView
public void selectLast()
selectLast
in interface ResultSetView
public int getNumberOfIndexes()
ResultSetView
getNumberOfIndexes
in interface ResultSetView
public void onSaveDoc(org.zkoss.zk.ui.event.Event event)
onSaveDoc
in interface ResultSetView
event
- eventResultSetView.onSaveDoc(org.zkoss.zk.ui.event.Event)
public void onChangeDocumentSecurity(org.zkoss.zk.ui.event.Event event)
onChangeDocumentSecurity
in interface ResultSetView
event
- eventResultSetView.onChangeDocumentSecurity(org.zkoss.zk.ui.event.Event)
public void onRefresh(org.zkoss.zk.ui.event.Event event)
onRefresh
in interface ResultSetView
event
- EventResultSetView.onRefresh(org.zkoss.zk.ui.event.Event)
public void refresh(boolean newQuery)
refresh
in interface ResultSetView
newQuery
- if true, the query will be executed on the backend system againResultSetView.refresh(boolean)
public void updateListItem(ResultListItem item)
ResultSetView
IllegalArgumentException
when the specified item is not contained in the
current query-result.updateListItem
in interface ResultSetView
item
- the item to be updatedpublic void onStartWorkflow(org.zkoss.zk.ui.event.Event event)
onStartWorkflow
in interface ResultSetView
event
- Event onStartWorkflow.ResultSetView.onStartWorkflow(org.zkoss.zk.ui.event.Event)
public void onLaunchWorkflow(org.zkoss.zk.ui.event.Event event)
onLaunchWorkflow
in interface ResultSetView
event
- EventResultSetView.onLaunchWorkflow(org.zkoss.zk.ui.event.Event)
public void onWorkflowAction(org.zkoss.zk.ui.event.Event event)
onWorkflowAction
in interface ResultSetView
event
- EventResultSetView.onWorkflowAction(org.zkoss.zk.ui.event.Event)
public void onWorkflowComment(org.zkoss.zk.ui.event.Event event)
onWorkflowComment
in interface ResultSetView
event
- EventResultSetView.onWorkflowComment(org.zkoss.zk.ui.event.Event)
public void onDeleteSelected(org.zkoss.zk.ui.event.Event event)
onDeleteSelected
in interface ResultSetView
event
- eventResultSetView.onDeleteSelected(org.zkoss.zk.ui.event.Event)
public void onUnDeleteSelected(org.zkoss.zk.ui.event.Event event)
onUnDeleteSelected
in interface ResultSetView
event
- eventResultSetView.onUnDeleteSelected(org.zkoss.zk.ui.event.Event)
public void onNewSelected(org.zkoss.zk.ui.event.Event event)
onNewSelected
in interface ResultSetView
event
- EventResultSetView.onNewSelected(org.zkoss.zk.ui.event.Event)
public void onEditItemSelected(org.zkoss.zk.ui.event.Event event)
onEditItemSelected
in interface ResultSetView
event
- EventResultSetView.onEditItemSelected(org.zkoss.zk.ui.event.Event)
public void onDocumentCheck(org.zkoss.zk.ui.event.Event event)
onDocumentCheck
in interface ResultSetView
event
- EventResultSetView.onDocumentCheck(org.zkoss.zk.ui.event.Event)
public void onDocumentRelease(org.zkoss.zk.ui.event.Event event)
onDocumentRelease
in interface ResultSetView
event
- EventResultSetView.onDocumentRelease(org.zkoss.zk.ui.event.Event)
public void onPrintDocuments(org.zkoss.zk.ui.event.Event event)
onPrintDocuments
in interface ResultSetView
event
- EventResultSetView.onPrintDocuments(org.zkoss.zk.ui.event.Event)
public void onExport(org.zkoss.zk.ui.event.Event event)
onExport
in interface ResultSetView
event
- EventResultSetView.onExport(org.zkoss.zk.ui.event.Event)
public List<DocumentId> getSelectedIds()
getSelectedIds
in interface ResultSetView
ResultSetView.getSelectedIds()
public final void setSelectQuery(String query)
setSelectQuery
in interface ResultSetView
query
- Query stringResultSetView.setSelectQuery(java.lang.String)
public final void setSelectWfQuery(String query, boolean perform)
setSelectWfQuery
in interface ResultSetView
query
- Query stringperform
- True for perform immediatelyResultSetView.setSelectWfQuery(java.lang.String, boolean)
public void performQuery(com.saperion.rmi.SaQueryInfo query)
performQuery
in interface ResultSetView
query
- query infoResultSetView.performQuery(com.saperion.rmi.SaQueryInfo)
public final String getSelectQuery()
getSelectQuery
in interface ResultSetView
ResultSetView.getSelectQuery()
public final void setPageSize(int size)
setPageSize
in interface ResultSetView
size
- page sizeResultSetView.setPageSize(int)
public final int getPageSize()
getPageSize
in interface ResultSetView
ResultSetView.getPageSize()
public final void setFilterViewShown(boolean showFilterView)
setFilterViewShown
in interface ResultSetView
showFilterView
- true if filter view should be shownResultSetView.setFilterViewShown(boolean)
public final boolean isFilterViewShown()
isFilterViewShown
in interface ResultSetView
ResultSetView.isFilterViewShown()
public final void setSelectedIndex(int index)
setSelectedIndex
in interface ResultSetView
index
- new index to selectResultSetView.setSelectedIndex(int)
public final int getSelectedIndex()
getSelectedIndex
in interface ResultSetView
ResultSetView.getSelectedIndex()
public final String getFieldsToDisplay()
getFieldsToDisplay
in interface ResultSetView
ResultSetView.getFieldsToDisplay()
public final void setFieldsToDisplay(String fieldstodisplay)
setFieldsToDisplay
in interface ResultSetView
fieldstodisplay
- the fieldsToDisplay to setResultSetView.setFieldsToDisplay(java.lang.String)
public final void setSortingDirections(String directions)
setSortingDirections
in interface ResultSetView
directions
- Comma-separated list of directions. Possible values: 'ascending', 'descending',
'natural', 'disabled'.ResultSetView.setSortingDirections(java.lang.String)
public final String getSortingDirections()
getSortingDirections
in interface ResultSetView
ResultSetView.getSortingDirections()
public final void setHeaderNames(String names)
setHeaderNames
in interface ResultSetView
names
- header namesResultSetView.setHeaderNames(java.lang.String)
public final String getHeaderNames()
getHeaderNames
in interface ResultSetView
ResultSetView.getHeaderNames()
public final void setHeaderAlignments(String alignments)
setHeaderAlignments
in interface ResultSetView
alignments
- alignments. Possible values: 'right', 'left', 'center'.ResultSetView.setHeaderAlignments(java.lang.String)
public final String getHeaderAlignments()
getHeaderAlignments
in interface ResultSetView
ResultSetView.getHeaderAlignments()
public final void setHeaderWidths(String widths)
setHeaderWidths
in interface ResultSetView
widths
- widths
When an invalid value was foundResultSetView.setHeaderWidths(java.lang.String)
public final String getHeaderWidths()
getHeaderWidths
in interface ResultSetView
public void afterSelect(boolean focus)
focus
- if true, the selected item will be focused@Deprecated public Set<DraggableListItem> getSelectedItems()
getSelectedListItems()
instead. Will be removed in 8.1.ResultSetView
getSelectedItems
in interface ResultSetView
ResultSetView.getSelectedItems()
@Deprecated public DraggableListItem getSelectedItem()
getSelectedListItem()
instead. Will be removed in 8.1.ResultSetView
getSelectedItem
in interface ResultSetView
ResultSetView.getSelectedItem()
public Set<ResultListItem> getSelectedListItems()
getSelectedListItems
in interface ResultSetView
ResultSetView.getSelectedListItems()
public ResultListItem getSelectedListItem()
getSelectedListItem
in interface ResultSetView
ResultSetView.getSelectedListItem()
public void onIndexChange(org.zkoss.zk.ui.event.Event event)
onIndexChange
in interface ResultSetView
event
- EventResultSetView.onIndexChange(org.zkoss.zk.ui.event.Event)
public void onResetGui(org.zkoss.zk.ui.event.Event event)
onResetGui
in interface ResultSetView
event
- ZK eventResultSetView.onResetGui(org.zkoss.zk.ui.event.Event)
public void onEditContent(org.zkoss.zk.ui.event.Event event)
onEditContent
in interface ResultSetView
event
- ZK eventResultSetView.onEditContent(org.zkoss.zk.ui.event.Event)
public void setResultColumns(Map<String,ResultSetColumn> resultColumns)
setResultColumns
in interface ResultSetView
resultColumns
- columnsResultSetView.setResultColumns(java.util.Map)
public List<DocumentVersionInfo> getDocumentVersions(DocumentId id)
id
- Document idpublic boolean isSimpleMode()
isSimpleMode
in interface ResultSetView
ResultSetView.isSimpleMode()
public void setSimpleMode(boolean mode)
setSimpleMode
in interface ResultSetView
mode
- parameter valueResultSetView.setSimpleMode(boolean)
public void setLookupMode()
public void setSelectLookupMode()
public String getFormName()
getFormName
in interface ResultSetView
ResultSetView.getFormName()
public void setFormName(String name)
setFormName
in interface ResultSetView
name
- Form nameResultSetView.setFormName(java.lang.String)
public boolean isSaveFavoriteEnabled()
isSaveFavoriteEnabled
in interface ResultSetView
ResultSetView.isSaveFavoriteEnabled()
public void setSaveFavoriteEnabled(boolean enabled)
setSaveFavoriteEnabled
in interface ResultSetView
enabled
- valueResultSetView.setSaveFavoriteEnabled(boolean)
public void setExportEnabled(boolean enabled)
setExportEnabled
in interface ResultSetView
enabled
- enabled or notResultSetView.setExportEnabled(boolean)
public boolean isExportEnabled()
isExportEnabled
in interface ResultSetView
ResultSetView.isExportEnabled()
public boolean isAutoSearch()
isAutoSearch
in interface ResultSetView
ResultSetView.isAutoSearch()
public void setTitle(String titleString)
setTitle
in interface ResultSetView
setTitle
in class org.zkoss.zul.Window
titleString
- title stringWindow.setTitle(java.lang.String)
public void onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
onPageAttached
in interface org.zkoss.zk.ui.sys.ComponentCtrl
onPageAttached
in class org.zkoss.zk.ui.AbstractComponent
AbstractComponent.onPageAttached(org.zkoss.zk.ui.Page,
org.zkoss.zk.ui.Page)
public void onPageDetached(org.zkoss.zk.ui.Page page)
onPageDetached
in interface org.zkoss.zk.ui.sys.ComponentCtrl
onPageDetached
in class org.zkoss.zul.Window
Window.onPageDetached(org.zkoss.zk.ui.Page)
public void addCustomMenuItem(org.zkoss.zul.Menuitem item, boolean multi)
multi
is true, the menu item will be added to the
single and multi selection menus.addCustomMenuItem
in interface ResultSetView
item
- the itemmulti
- set to true if the item should be available for multi selectionResultSetView.addCustomMenuItem(org.zkoss.zul.Menuitem,
boolean)
public List<org.zkoss.zul.Menuitem> getCustomMenuItems(boolean multi)
getCustomMenuItems
in interface ResultSetView
multi
- if true, the menu items returned can be used with multi selectionResultSetView.getCustomMenuItems(boolean)
public void addCustomMenu(org.zkoss.zul.Menu menu, boolean multi)
multi
is true, the menu item will be added to the single
and multi selection menus.addCustomMenu
in interface ResultSetView
menu
- the menumulti
- set to true if the menu should be available for multi selectionResultSetView.addCustomMenu(Menu, boolean)
public List<org.zkoss.zul.Menu> getCustomMenus(boolean multi)
getCustomMenus
in interface ResultSetView
multi
- if true, the menus returned can be used with multi selectionResultSetView.getCustomMenus(boolean)
public List<ResultProperties> getSelectedRows()
getSelectedRows
in interface ResultSetView
ResultSetView.getSelectedRows()
public List<ResultProperties> getAllRows()
getAllRows
in interface ResultSetView
ResultSetView.getAllRows()
public IntelligentFormView getParentForm()
getParentForm
in interface ResultSetView
IntelligentField.getParentForm()
public ResultList getResultSetList()
ResultSetView
ResultList
used in this ResultSetView.getResultSetList
in interface ResultSetView
ResultList
used in this ResultSetViewpublic com.saperion.ngc.iform.xml.ResultType getResultType()
ResultSetView
ResultType
that contains the properties of this ResultSetView as defined
in the QBE-form.getResultType
in interface ResultSetView
ResultType
of this ResultSetViewpublic void setFileParent(FolderId parent)
parent
- parent folder for filing actionspublic FolderId getFileParent()
public String getAllowed()
getAllowed
in interface ResultSetView
public void setAllowed(String value)
setAllowed
in interface ResultSetView
value
- Comma separated list of allowed features. One of: EDIT, DELETE, INDEX, SAVE, NEW,
VIEW, SECURITYResultSetView.setAllowed(java.lang.String)
public boolean getDefaultMenu()
getDefaultMenu
in interface ResultSetView
ResultSetView.getDefaultMenu()
public void setDefaultMenu(boolean value)
setDefaultMenu
in interface ResultSetView
value
- True for switched on default menu.ResultSetView.setDefaultMenu(boolean)
public ResultSetViewImpl.ViewMode getViewMode()
public ResultSetViewFilterArea getResultSetViewFilterArea()
public void initializePaging(ResultPaging paging)
ResultSetView
initializePaging
in interface ResultSetView
paging
- pagingpublic org.zkoss.zul.Menupopup getContextMenuPopup()
addCustomMenu
or
addCustomMenuItem
instead.getContextMenuPopup
in interface ResultSetView
ResultSetView.getContextMenuPopup()
public void setDefaultButtonType(ResultSetView.DefaultButtonType defaultButton)
setDefaultButtonType
in interface ResultSetView
defaultButton
- default button type to be set(com.saperion.ngc.resultset.ResultSetView.DefaultButtonType)
public ResultSetView.DefaultButtonType getDefaultButtonType()
getDefaultButtonType
in interface ResultSetView
ResultSetView.getDefaultButtonType()
public String getIndexMask()
getIndexMask
in interface ResultSetView
ResultSetView.getIndexMask()
public String getMaskName()
public void setSaveLayout(boolean save)
setSaveLayout
in interface ResultSetView
save
- true to enable, false to disableResultSetView.setSaveLayout(boolean)
public boolean isSaveLayout()
isSaveLayout
in interface ResultSetView
ResultSetView.isSaveLayout()
public void setRemoveMenuItemList(List<MenuItemKey> removeList, boolean multi)
setRemoveMenuItemList
in interface ResultSetView
removeList
- List of items.multi
- True for multiselectResultSetView.setRemoveMenuItemList(java.util.List, boolean)
public List<MenuItemKey> getRemoveMenuItemList(boolean multi)
getRemoveMenuItemList
in interface ResultSetView
multi
- True for multiselectResultSetView.getRemoveMenuItemList(boolean)
public void deleteConfiguration()
deleteConfiguration
in interface ResultSetView
ResultSetView.deleteConfiguration()
public void setMaxRecords(int maxRecords)
maxRecords
- maximum number of recordspublic int getMaxRecords()
public void setSearchMode(SearchMode mode)
SearchMode
for possible modes.setSearchMode
in interface ResultSetView
mode
- the search mode to useResultSetView.setSearchMode(com.saperion.ngc.resultset.SearchMode)
public SearchMode getSearchMode()
getSearchMode
in interface ResultSetView
ResultSetView.getSearchMode()
public void export()
export
in interface ResultSetView
ResultSetView.export()
public void export(Map<String,String> columnsToExport, ResultSetView.ExportFormat format, String filename)
export
in interface ResultSetView
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 tofilename
- the name of the resulting fileResultSetView.export(java.util.Map,
com.saperion.ngc.resultset.ResultSetView.ExportFormat, java.lang.String)
public int getTotalSize()
getTotalSize
in interface ResultSetView
ResultSetView.getTotalSize()
@Deprecated public void setDocumentRead(DraggableListItem item)
setDocumentRead(ResultListItem)
instead. Will be removed in 8.1.ResultSetView
setDocumentRead
in interface ResultSetView
item
- item to changeResultSetView.setDocumentRead(com.saperion.ngc.resultset.DraggableListItem)
@Deprecated public void setDocumentUnread(DraggableListItem item)
setDocumentUnread(ResultListItem)
instead. Will be removed in 8.1.ResultSetView
setDocumentUnread
in interface ResultSetView
item
- item to changeResultSetView.setDocumentUnread(com.saperion.ngc.resultset.DraggableListItem)
public void setDocumentRead(ResultListItem item)
setDocumentRead
in interface ResultSetView
item
- item to changeResultSetView.setDocumentRead(com.saperion.ngc.resultset.DraggableListItem)
public void setDocumentUnread(ResultListItem item)
setDocumentUnread
in interface ResultSetView
item
- item to changeResultSetView.setDocumentUnread(com.saperion.ngc.resultset.DraggableListItem)
public void addCustomCondition(FieldResultBean condition)
addCustomCondition
in interface ResultSetView
condition
- a FieldResultBean
or a CustomConditionBean
with the conditionResultSetView.addCustomCondition(com.saperion.ngc.iform.FieldResultBean)
public List<FieldResultBean> getCustomConditions()
getCustomConditions
in interface ResultSetView
ResultSetView.addCustomCondition(FieldResultBean)
. The returned list can be modified.ResultSetView.getCustomConditions()
public void setResultListClass(Class<? extends ResultList> clazz)
ResultSetView
ResultList
. The default is
ResultListImpl
. The class must have a constructor with no arguments.setResultListClass
in interface ResultSetView
clazz
- class to be usedpublic void setCustomSortSequences(Map<String,SortDirection> sortSequences)
ResultSetView
setCustomSortSequences
in interface ResultSetView
sortSequences
- a map that maps the database-name of a column with a SortDirection
public Map<String,SortDirection> getCustomSortSequences()
getCustomSortSequences
in interface ResultSetView
ResultSetView.setCustomSortSequences(Map)
. If no custom
sort sequences were set, this method returns an empty map.public void onUploadSuccess(org.zkoss.zk.ui.event.Event event)
ResultSetView
onUploadSuccess
in interface ResultSetView
event
- eventpublic PropertyToStringConverter getPropertyConverter()
ResultSetView
SaPropertyValue
instances to strings.
The converter is initialized with the current locale and the DDC used by this ResultSetView.getPropertyConverter
in interface ResultSetView
public Set<org.zkoss.zul.Menupopup> getHeaderMenuPopups()
Copyright © 2021 Hyland Software Germany GmbH. All rights reserved.