com.saperion.ngc.resultset

Class ResultSetViewImpl

java.lang.Object

org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zul.impl.XulElement

org.zkoss.zul.Window

com.saperion.ngc.events.BaseWindow

com.saperion.ngc.resultset.ResultSetViewImpl

All Implemented Interfaces:

EventChild, EventChildHandler, LogEventChildHandler, ResultSetView, Serializable, Cloneable, org.zkoss.zk.ui.api.HtmlBasedComponent, org.zkoss.zk.ui.Component, org.zkoss.zk.ui.ext.Scope, org.zkoss.zk.ui.IdSpace, org.zkoss.zk.ui.sys.ComponentCtrl, org.zkoss.zul.api.Window, org.zkoss.zul.ext.Framable, org.zkoss.zul.impl.api.XulElement

public class ResultSetViewImpl
extends BaseWindow
implements ResultSetView

Implementation of ResultSetView.

Important events:

• 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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResultSetViewImpl.ViewMode Enumeration for view modes.

Nested classes/interfaces inherited from class org.zkoss.zk.ui.HtmlBasedComponent

org.zkoss.zk.ui.HtmlBasedComponent.ExtraCtrl

Nested classes/interfaces inherited from class org.zkoss.zk.ui.AbstractComponent

org.zkoss.zk.ui.AbstractComponent.Children

Nested classes/interfaces inherited from interface com.saperion.ngc.resultset.ResultSetView

ResultSetView.DefaultButtonType, ResultSetView.ExportFormat

Field Summary

Fields inherited from class org.zkoss.zul.Window

EMBEDDED, HIGHLIGHTED, MODAL, OVERLAPPED, POPUP

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

_zclass

Fields inherited from interface com.saperion.ngc.resultset.ResultSetView

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

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_EXPAND_NODE, 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

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
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.

Method Summary

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	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()
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.0.
Set<DraggableListItem>	getSelectedItems() Deprecated. use getSelectedListItems() instead. Will be removed in 8.0.
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.0.
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.0..
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.

Methods inherited from class com.saperion.ngc.events.BaseWindow

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

Methods inherited from class org.zkoss.zul.Window

beforeChildAdded, clone, doEmbedded, doHighlighted, doModal, doOverlapped, doPopup, getBorder, getCaption, getCaptionApi, getContentSclass, getContentStyle, getDefaultActionOnShow, getMinheight, getMinwidth, getMode, 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, setPosition, setShadow, setSizable, setTopmost, setVisible

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, getExtraCtrl, getHeight, getHflex, getLeft, getRenderdefer, getSclass, getStyle, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, 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, getChildren, 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, onWrongValue, redraw, redrawChildren, removeAttribute, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, removeScopeListener, render, render, render, renderIdSpace, response, response, sessionDidActivate, sessionWillPassivate, setAttribute, setAttribute, setAttribute, setAuService, setDefinition, setDefinition, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setVariable, 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 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

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, setDroppable, setFocus, setHeight, setLeft, setRenderdefer, setSclass, setStyle, setTooltiptext, setTop, setWidth, setZclass, setZindex, setZIndex

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

getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, hasFellow, hasFellow

Constructor Detail

ResultSetViewImpl

public ResultSetViewImpl()

Constructor.

ResultSetViewImpl

public ResultSetViewImpl(boolean showTitleArea)

Constructor for use in LookupPopup.

Parameters:

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.

ResultSetViewImpl

public 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.

Parameters:

definition - component definition

stretch - true if the component should fill its container

maskName - Mask name

panePos - Pane position

ddc - DDC name

Method Detail

getOriginalItemIndex

public int getOriginalItemIndex()

Description copied from interface: ResultSetView

Returns the original index of the currently selected item or -1 if no item is selected.

Specified by:

getOriginalItemIndex in interface ResultSetView

Returns:

the original given item index

See Also:

ResultSetView.getOriginalItemIndex()

getCenter

public org.zkoss.zul.Center getCenter()

Returns:

main boderlayout-center of the ResultSetView

doSort

public void doSort()

Sorts the current result. The sort-directions are taken from the headers returned by ResultList.getHeaderInformation().

clearResultSet

public final void clearResultSet()

Removes all child-components from ResultSetView-Center. Inserts a not-found-label. Clears the result set.

Specified by:

clearResultSet in interface ResultSetView

See Also:

ResultSetView.clearResultSet()

reset

public final void reset()

Removes the ResultSetList from main-center. Reset view.

Specified by:

reset in interface ResultSetView

See Also:

ResultSetView.reset()

releaseLocks

public void releaseLocks()

Unlocks all documents. Unlocks all previously locked documents.

Specified by:

releaseLocks in interface ResultSetView

See Also:

ResultSetView.releaseLocks()

onSelectDDC

public void onSelectDDC(org.zkoss.zk.ui.event.Event event)

Fires a SelectDDCEvent. Handle DDC select event.

Specified by:

onSelectDDC in interface ResultSetView

Parameters:

event - the event contains the database to be select

See Also:

ResultSetView.onSelectDDC(org.zkoss.zk.ui.event.Event)

onDownloadResultItem

public void onDownloadResultItem(org.zkoss.zk.ui.event.Event event)

Fires onDownloadResultItem-event for downloading items (containing in event) from server. Handle download document event.

Specified by:

onDownloadResultItem in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onDownloadResultItem(org.zkoss.zk.ui.event.Event)

onSendMailResultItem

public void onSendMailResultItem(org.zkoss.zk.ui.event.Event event)

Fires onSendMailResultItem-event for sending items (contained in event) as mail from server. Handle send documents as mail event.

Specified by:

onSendMailResultItem in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onSendMailResultItem(org.zkoss.zk.ui.event.Event)

onNavigationFolder

public void onNavigationFolder(org.zkoss.zk.ui.event.Event event)

Fires onNavigationFolder-event for showing folder documents.

Specified by:

onNavigationFolder in interface ResultSetView

Parameters:

event - - Event on Navigation Folder.

See Also:

ResultSetView.onNavigationFolder(org.zkoss.zk.ui.event.Event)

onButtonQuery

public void onButtonQuery(org.zkoss.zk.ui.event.Event event)

Fires onButtonQuery-event for executing a database-query. Handles query button.

Specified by:

onButtonQuery in interface ResultSetView

Parameters:

event - Events

See Also:

ResultSetView.onButtonQuery(org.zkoss.zk.ui.event.Event)

onEditSelected

public void onEditSelected(org.zkoss.zk.ui.event.Event event)

Fires onEditSelected-event for editing selected items in combo box. Locks the selected row.

Specified by:

onEditSelected in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onEditSelected(org.zkoss.zk.ui.event.Event)

onCancelEdit

public void onCancelEdit(org.zkoss.zk.ui.event.Event event)

Fires onCancelEdit-event for cancel editing selected items in combo box. Event handler for cancel edit event.

Specified by:

onCancelEdit in interface ResultSetView

Parameters:

event - event

See Also:

ResultSetView.onCancelEdit(org.zkoss.zk.ui.event.Event)

onEditStructure

public void onEditStructure(org.zkoss.zk.ui.event.Event event)

Handles event to edit a document's structure.

Specified by:

onEditStructure in interface ResultSetView

Parameters:

event - event

See Also:

ResultSetView.onEditStructure(org.zkoss.zk.ui.event.Event)

selectNext

public void selectNext()

selects the next row.

Specified by:

selectNext in interface ResultSetView

selectPrevious

public void selectPrevious()

selects the previous row.

Specified by:

selectPrevious in interface ResultSetView

selectFirst

public void selectFirst()

selects the first valid row.

Specified by:

selectFirst in interface ResultSetView

selectLast

public void selectLast()

selects the last valid row.

Specified by:

selectLast in interface ResultSetView

getNumberOfIndexes

public int getNumberOfIndexes()

Description copied from interface: ResultSetView

Returns the number of items in this list.

Specified by:

getNumberOfIndexes in interface ResultSetView

Returns:

item count in result-list.

onSaveDoc

public void onSaveDoc(org.zkoss.zk.ui.event.Event event)

Event handler for save document event.

Specified by:

onSaveDoc in interface ResultSetView

Parameters:

event - event

See Also:

ResultSetView.onSaveDoc(org.zkoss.zk.ui.event.Event)

onChangeDocumentSecurity

public void onChangeDocumentSecurity(org.zkoss.zk.ui.event.Event event)

Event handler for change of document security.

Specified by:

onChangeDocumentSecurity in interface ResultSetView

Parameters:

event - event

See Also:

ResultSetView.onChangeDocumentSecurity(org.zkoss.zk.ui.event.Event)

onRefresh

public void onRefresh(org.zkoss.zk.ui.event.Event event)

Refresh the view.

Specified by:

onRefresh in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onRefresh(org.zkoss.zk.ui.event.Event)

refresh

public void refresh(boolean newQuery)

Refreshes the result list.

Specified by:

refresh in interface ResultSetView

Parameters:

newQuery - if true, the query will be executed on the backend system again

See Also:

ResultSetView.refresh(boolean)

updateListItem

public void updateListItem(ResultListItem item)

Description copied from interface: ResultSetView

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.

Specified by:

updateListItem in interface ResultSetView

Parameters:

item - the item to be updated

onStartWorkflow

public void onStartWorkflow(org.zkoss.zk.ui.event.Event event)

Fires onStartWorkflow-event for starting the workflow for the selected document.

Specified by:

onStartWorkflow in interface ResultSetView

Parameters:

event - Event onStartWorkflow.

See Also:

ResultSetView.onStartWorkflow(org.zkoss.zk.ui.event.Event)

onLaunchWorkflow

public void onLaunchWorkflow(org.zkoss.zk.ui.event.Event event)

Launch an workflow after user selection. Launch an workflow after user selection.

Specified by:

onLaunchWorkflow in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onLaunchWorkflow(org.zkoss.zk.ui.event.Event)

onWorkflowAction

public void onWorkflowAction(org.zkoss.zk.ui.event.Event event)

Performs a workflow action. Performs a workflow action.

Specified by:

onWorkflowAction in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onWorkflowAction(org.zkoss.zk.ui.event.Event)

onWorkflowComment

public void onWorkflowComment(org.zkoss.zk.ui.event.Event event)

Performs a workflow action. Handle workflow comment event.

Specified by:

onWorkflowComment in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onWorkflowComment(org.zkoss.zk.ui.event.Event)

onDeleteSelected

public void onDeleteSelected(org.zkoss.zk.ui.event.Event event)

Delete selected documents.

Specified by:

onDeleteSelected in interface ResultSetView

Parameters:

event - event

See Also:

ResultSetView.onDeleteSelected(org.zkoss.zk.ui.event.Event)

onUnDeleteSelected

public void onUnDeleteSelected(org.zkoss.zk.ui.event.Event event)

Undelete selected documents.

Specified by:

onUnDeleteSelected in interface ResultSetView

Parameters:

event - event

See Also:

ResultSetView.onUnDeleteSelected(org.zkoss.zk.ui.event.Event)

onNewSelected

public void onNewSelected(org.zkoss.zk.ui.event.Event event)

Creates a new row.

Specified by:

onNewSelected in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onNewSelected(org.zkoss.zk.ui.event.Event)

onEditItemSelected

public void onEditItemSelected(org.zkoss.zk.ui.event.Event event)

Edit an existing row.

Specified by:

onEditItemSelected in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onEditItemSelected(org.zkoss.zk.ui.event.Event)

onDocumentCheck

public void onDocumentCheck(org.zkoss.zk.ui.event.Event event)

Checkout / checkin actual document.

Specified by:

onDocumentCheck in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onDocumentCheck(org.zkoss.zk.ui.event.Event)

onDocumentRelease

public void onDocumentRelease(org.zkoss.zk.ui.event.Event event)

Release actual document.

Specified by:

onDocumentRelease in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onDocumentRelease(org.zkoss.zk.ui.event.Event)

onPrintDocuments

public void onPrintDocuments(org.zkoss.zk.ui.event.Event event)

Print selected documents.

Specified by:

onPrintDocuments in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onPrintDocuments(org.zkoss.zk.ui.event.Event)

onExport

public void onExport(org.zkoss.zk.ui.event.Event event)

Export current result.

Specified by:

onExport in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onExport(org.zkoss.zk.ui.event.Event)

getSelectedIds

public List<DocumentId> getSelectedIds()

Returns the IDs of the selected documents.

Specified by:

getSelectedIds in interface ResultSetView

Returns:

Id's from selected items in result list.

See Also:

ResultSetView.getSelectedIds()

setSelectQuery

public final void setSelectQuery(String query)

Setter for selectQuery attribute to be used in zul. Performs execution of the given query.

Specified by:

setSelectQuery in interface ResultSetView

Parameters:

query - Query string

See Also:

ResultSetView.setSelectQuery(java.lang.String)

setSelectWfQuery

public final void setSelectWfQuery(String query,
                    boolean perform)

Setter for selectQuery attribute to be used in zul. Performs execution of the given query.

Specified by:

setSelectWfQuery in interface ResultSetView

Parameters:

query - Query string

perform - True for perform immediately

See Also:

ResultSetView.setSelectWfQuery(java.lang.String, boolean)

performQuery

public void performQuery(com.saperion.rmi.SaQueryInfo query)

Performs execution of the given query.

Specified by:

performQuery in interface ResultSetView

Parameters:

query - query info

See Also:

ResultSetView.performQuery(com.saperion.rmi.SaQueryInfo)

getSelectQuery

public final String getSelectQuery()

Specified by:

getSelectQuery in interface ResultSetView

Returns:

select query

See Also:

ResultSetView.getSelectQuery()

setPageSize

public final void setPageSize(int size)

Sets the page size of the list.

Specified by:

setPageSize in interface ResultSetView

Parameters:

size - page size

See Also:

ResultSetView.setPageSize(int)

getPageSize

public final int getPageSize()

Specified by:

getPageSize in interface ResultSetView

Returns:

the page size

See Also:

ResultSetView.getPageSize()

setFilterViewShown

public final void setFilterViewShown(boolean showFilterView)

Enables or disables the filter view.

Specified by:

setFilterViewShown in interface ResultSetView

Parameters:

showFilterView - true if filter view should be shown

See Also:

ResultSetView.setFilterViewShown(boolean)

isFilterViewShown

public final boolean isFilterViewShown()

Specified by:

isFilterViewShown in interface ResultSetView

Returns:

filter view shown

See Also:

ResultSetView.isFilterViewShown()

setSelectedIndex

public final 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.

Specified by:

setSelectedIndex in interface ResultSetView

Parameters:

index - new index to select

See Also:

ResultSetView.setSelectedIndex(int)

getSelectedIndex

public final int getSelectedIndex()

Returns the currently selected index.

Specified by:

getSelectedIndex in interface ResultSetView

Returns:

the currently selected index

See Also:

ResultSetView.getSelectedIndex()

getFieldsToDisplay

public final String getFieldsToDisplay()

Specified by:

getFieldsToDisplay in interface ResultSetView

Returns:

the fieldsToDisplay

See Also:

ResultSetView.getFieldsToDisplay()

setFieldsToDisplay

public final void setFieldsToDisplay(String fieldstodisplay)

Specified by:

setFieldsToDisplay in interface ResultSetView

Parameters:

fieldstodisplay - the fieldsToDisplay to set

See Also:

ResultSetView.setFieldsToDisplay(java.lang.String)

setSortingDirections

public final void setSortingDirections(String directions)
                                throws org.zkoss.util.InvalidValueException

Sets the sorting direction for each column from left to right. Can only be set in combination with fieldsToDisplay.

Specified by:

setSortingDirections in interface ResultSetView

Parameters:

directions - Comma-separated list of directions. Possible values: 'ascending', 'descending', 'natural', 'disabled'.

Throws:

org.zkoss.util.InvalidValueException - when an invalid value was found

See Also:

ResultSetView.setSortingDirections(java.lang.String)

getSortingDirections

public final String getSortingDirections()

Specified by:

getSortingDirections in interface ResultSetView

Returns:

sorting directions

See Also:

ResultSetView.getSortingDirections()

setHeaderNames

public final void setHeaderNames(String names)

Sets the names of the column headers from left to right. Can only be set in combination with fieldsToDisplay.

Specified by:

setHeaderNames in interface ResultSetView

Parameters:

names - header names

See Also:

ResultSetView.setHeaderNames(java.lang.String)

getHeaderNames

public final String getHeaderNames()

Specified by:

getHeaderNames in interface ResultSetView

Returns:

the preset header names

See Also:

ResultSetView.getHeaderNames()

setHeaderAlignments

public final void setHeaderAlignments(String alignments)
                               throws org.zkoss.util.InvalidValueException

Sets the alignments of the headers. Can only be set in combination with fieldsToDisplay.

Specified by:

setHeaderAlignments in interface ResultSetView

Parameters:

alignments - alignments. Possible values: 'right', 'left', 'center'.

Throws:

org.zkoss.util.InvalidValueException - when an invalid value was found

See Also:

ResultSetView.setHeaderAlignments(java.lang.String)

getHeaderAlignments

public final String getHeaderAlignments()

Specified by:

getHeaderAlignments in interface ResultSetView

Returns:

header alignments

See Also:

ResultSetView.getHeaderAlignments()

setHeaderWidths

public final void setHeaderWidths(String widths)
                           throws org.zkoss.util.InvalidValueException

Sets the widths of the headers. Can only be used in combination with fieldsToDisplay.

Specified by:

setHeaderWidths in interface ResultSetView

Parameters:

widths - widths

Throws:

org.zkoss.util.InvalidValueException - When an invalid value was found

See Also:

ResultSetView.setHeaderWidths(java.lang.String)

getHeaderWidths

public final String getHeaderWidths()

Specified by:

getHeaderWidths in interface ResultSetView

Returns:

header widths

afterSelect

public void afterSelect(boolean focus)

Performs the necessary actions after an item was selected.

Parameters:

focus - if true, the selected item will be focused

getSelectedItems

@Deprecated
public Set<DraggableListItem> getSelectedItems()

Deprecated. use getSelectedListItems() instead. Will be removed in 8.0.

Description copied from interface: ResultSetView

Returns all selected items.

Specified by:

getSelectedItems in interface ResultSetView

Returns:

selected items

See Also:

ResultSetView.getSelectedItems()

getSelectedItem

@Deprecated
public DraggableListItem getSelectedItem()

Deprecated. use getSelectedListItem() instead. Will be removed in 8.0.

Description copied from interface: ResultSetView

Returns the selected item.

Specified by:

getSelectedItem in interface ResultSetView

Returns:

selected item

See Also:

ResultSetView.getSelectedItem()

getSelectedListItems

public Set<ResultListItem> getSelectedListItems()

Returns all selected items.

Specified by:

getSelectedListItems in interface ResultSetView

Returns:

selected items

See Also:

ResultSetView.getSelectedListItems()

getSelectedListItem

public ResultListItem getSelectedListItem()

Returns the selected item.

Specified by:

getSelectedListItem in interface ResultSetView

Returns:

selected item

See Also:

ResultSetView.getSelectedListItem()

onIndexChange

public void onIndexChange(org.zkoss.zk.ui.event.Event event)

Perform a query based on a document selected by another view.

Specified by:

onIndexChange in interface ResultSetView

Parameters:

event - Event

See Also:

ResultSetView.onIndexChange(org.zkoss.zk.ui.event.Event)

onResetGui

public void onResetGui(org.zkoss.zk.ui.event.Event event)

Handler for reset ui event.

Specified by:

onResetGui in interface ResultSetView

Parameters:

event - ZK event

See Also:

ResultSetView.onResetGui(org.zkoss.zk.ui.event.Event)

onEditContent

public void onEditContent(org.zkoss.zk.ui.event.Event event)

Handler for edit content event.

Specified by:

onEditContent in interface ResultSetView

Parameters:

event - ZK event

See Also:

ResultSetView.onEditContent(org.zkoss.zk.ui.event.Event)

setResultColumns

public void setResultColumns(Map<String,ResultSetColumn> resultColumns)

Sets the columns for the result list.

Specified by:

setResultColumns in interface ResultSetView

Parameters:

resultColumns - columns

See Also:

ResultSetView.setResultColumns(java.util.Map)

getDocumentVersions

public List<DocumentVersionInfo> getDocumentVersions(DocumentId id)

Parameters:

id - Document id

Returns:

Version info for this id

isSimpleMode

public boolean isSimpleMode()

Specified by:

isSimpleMode in interface ResultSetView

Returns:

simple mode parameter value

See Also:

ResultSetView.isSimpleMode()

setSimpleMode

public void setSimpleMode(boolean mode)

Sets the simple mode parameter.

Specified by:

setSimpleMode in interface ResultSetView

Parameters:

mode - parameter value

See Also:

ResultSetView.setSimpleMode(boolean)

setLookupMode

public void setLookupMode()

Set the list to lookup mode.

setSelectLookupMode

public void setSelectLookupMode()

Set the list to select lookup mode.

setVisibleColumns

public void setVisibleColumns(Set<String> columns)

Parameters:

columns - Columns

getFormName

public String getFormName()

Specified by:

getFormName in interface ResultSetView

Returns:

Form name

See Also:

ResultSetView.getFormName()

setFormName

public void setFormName(String name)

Specified by:

setFormName in interface ResultSetView

Parameters:

name - Form name

See Also:

ResultSetView.setFormName(java.lang.String)

isSaveFavoriteEnabled

public boolean isSaveFavoriteEnabled()

Specified by:

isSaveFavoriteEnabled in interface ResultSetView

Returns:

saveFavoriteEnabled parameter

See Also:

ResultSetView.isSaveFavoriteEnabled()

setSaveFavoriteEnabled

public void setSaveFavoriteEnabled(boolean enabled)

Sets the saveFavoriteEnabled parameter.

Specified by:

setSaveFavoriteEnabled in interface ResultSetView

Parameters:

enabled - value

See Also:

ResultSetView.setSaveFavoriteEnabled(boolean)

setExportEnabled

public void setExportEnabled(boolean enabled)

Enables or disables the export button.

Specified by:

setExportEnabled in interface ResultSetView

Parameters:

enabled - enabled or not

See Also:

ResultSetView.setExportEnabled(boolean)

isExportEnabled

public boolean isExportEnabled()

Specified by:

isExportEnabled in interface ResultSetView

Returns:

whether export is enabled or not

See Also:

ResultSetView.isExportEnabled()

isAutoSearch

public boolean isAutoSearch()

Specified by:

isAutoSearch in interface ResultSetView

Returns:

Auto search on.

See Also:

ResultSetView.isAutoSearch()

setTitle

public void setTitle(String titleString)

Sets the title. Used in iForms to display frame title.

Specified by:

setTitle in interface ResultSetView

Specified by:

setTitle in interface org.zkoss.zul.api.Window

Overrides:

setTitle in class org.zkoss.zul.Window

Parameters:

titleString - title string

See Also:

Window.setTitle(java.lang.String)

onPageAttached

public void onPageAttached(org.zkoss.zk.ui.Page newpage,
                  org.zkoss.zk.ui.Page oldpage)

Specified by:

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

Overrides:

onPageAttached in class org.zkoss.zk.ui.AbstractComponent

See Also:

AbstractComponent.onPageAttached(org.zkoss.zk.ui.Page, org.zkoss.zk.ui.Page)

onPageDetached

public void onPageDetached(org.zkoss.zk.ui.Page page)

Specified by:

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

Overrides:

onPageDetached in class org.zkoss.zul.Window

See Also:

Window.onPageDetached(org.zkoss.zk.ui.Page)

addCustomMenuItem

public 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.

Specified by:

addCustomMenuItem in interface ResultSetView

Parameters:

item - the item

multi - set to true if the item should be available for multi selection

See Also:

ResultSetView.addCustomMenuItem(org.zkoss.zul.Menuitem, boolean)

getCustomMenuItems

public List<org.zkoss.zul.Menuitem> getCustomMenuItems(boolean multi)

Returns the custom menu items.

Specified by:

getCustomMenuItems in interface ResultSetView

Parameters:

multi - if true, the menu items returned can be used with multi selection

Returns:

map with label/menuitem pairs

See Also:

ResultSetView.getCustomMenuItems(boolean)

addCustomMenu

public 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.

Specified by:

addCustomMenu in interface ResultSetView

Parameters:

menu - the menu

multi - set to true if the menu should be available for multi selection

See Also:

ResultSetView.addCustomMenu(Menu, boolean)

getCustomMenus

public List<org.zkoss.zul.Menu> getCustomMenus(boolean multi)

Returns the custom menus.

Specified by:

getCustomMenus in interface ResultSetView

Parameters:

multi - if true, the menus returned can be used with multi selection

Returns:

list of menus

See Also:

ResultSetView.getCustomMenus(boolean)

getSelectedRows

public List<ResultProperties> getSelectedRows()

Returns a list containing the properties of the selected rows. If no row is selected, an empty list is returned.

Specified by:

getSelectedRows in interface ResultSetView

Returns:

list of properties of the selected rows

See Also:

ResultSetView.getSelectedRows()

getAllRows

public List<ResultProperties> getAllRows()

Returns a list containing the properties of all rows.

Specified by:

getAllRows in interface ResultSetView

Returns:

list of properties of all rows

See Also:

ResultSetView.getAllRows()

getParentForm

public IntelligentFormView getParentForm()

Returns the parent form or null if this field is not part of a form.

Specified by:

getParentForm in interface ResultSetView

Returns:

parent form or null

See Also:

IntelligentField.getParentForm()

getResultSetList

public ResultList getResultSetList()

Description copied from interface: ResultSetView

Returns the ResultList used in this ResultSetView.

Specified by:

getResultSetList in interface ResultSetView

Returns:

ResultList used in this ResultSetView

getResultType

public com.saperion.ngc.iform.xml.ResultType getResultType()

Description copied from interface: ResultSetView

Returns the ResultType that contains the properties of this ResultSetView as defined in the QBE-form.

Specified by:

getResultType in interface ResultSetView

Returns:

the ResultType of this ResultSetView

setFileParent

public void setFileParent(FolderId parent)

Sets the folder this result list is using.

Parameters:

parent - parent folder for filing actions

getFileParent

public FolderId getFileParent()

Returns:

parent folder for filing actions

getAllowed

public String getAllowed()

Specified by:

getAllowed in interface ResultSetView

Returns:

Returns all allowed features.

setAllowed

public void setAllowed(String value)

Specified by:

setAllowed in interface ResultSetView

Parameters:

value - Comma separated list of allowed features. One of: EDIT, DELETE, INDEX, SAVE, NEW, VIEW, SECURITY

See Also:

ResultSetView.setAllowed(java.lang.String)

getDefaultMenu

public boolean getDefaultMenu()

Specified by:

getDefaultMenu in interface ResultSetView

Returns:

True, if default menu switched on.

See Also:

ResultSetView.getDefaultMenu()

setDefaultMenu

public void setDefaultMenu(boolean value)

Specified by:

setDefaultMenu in interface ResultSetView

Parameters:

value - True for switched on default menu.

See Also:

ResultSetView.setDefaultMenu(boolean)

getViewMode

public ResultSetViewImpl.ViewMode getViewMode()

Returns:

the view-mode used by this result-set

getResultSetViewFilterArea

public ResultSetViewFilterArea getResultSetViewFilterArea()

Returns:

current Filter-Area (north)

initializePaging

public void initializePaging(ResultPaging paging)

Description copied from interface: ResultSetView

Initialize paging options.

Specified by:

initializePaging in interface ResultSetView

Parameters:

paging - paging

getContextMenuPopup

public 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.

Specified by:

getContextMenuPopup in interface ResultSetView

Returns:

the context menu popup of the result list

See Also:

ResultSetView.getContextMenuPopup()

setDefaultButtonType

public void setDefaultButtonType(ResultSetView.DefaultButtonType defaultButton)

Sets the default type of button to be shown for each item in result list.

Specified by:

setDefaultButtonType in interface ResultSetView

Parameters:

defaultButton - default button type to be set

See Also:

(com.saperion.ngc.resultset.ResultSetView.DefaultButtonType)

getDefaultButtonType

public ResultSetView.DefaultButtonType getDefaultButtonType()

Specified by:

getDefaultButtonType in interface ResultSetView

Returns:

the default type of button to be shown for each item in result list.

See Also:

ResultSetView.getDefaultButtonType()

getIndexMask

public String getIndexMask()

Specified by:

getIndexMask in interface ResultSetView

Returns:

the index mask defined in the definition of this ResultSetView

See Also:

ResultSetView.getIndexMask()

getMaskName

public String getMaskName()

get the MaskName .

Returns:

maskName

setSaveLayout

public void setSaveLayout(boolean save)

Enables or disabled saving of the layout.

Specified by:

setSaveLayout in interface ResultSetView

Parameters:

save - true to enable, false to disable

See Also:

ResultSetView.setSaveLayout(boolean)

isSaveLayout

public boolean isSaveLayout()

Checks if save layout is enabled.

Specified by:

isSaveLayout in interface ResultSetView

Returns:

true, if enabled, false if not.

See Also:

ResultSetView.isSaveLayout()

setRemoveMenuItemList

public void setRemoveMenuItemList(List<MenuItemKey> removeList,
                         boolean multi)

Set menu items for removing.

Specified by:

setRemoveMenuItemList in interface ResultSetView

Parameters:

removeList - List of items.

multi - True for multiselect

See Also:

ResultSetView.setRemoveMenuItemList(java.util.List, boolean)

getRemoveMenuItemList

public List<MenuItemKey> getRemoveMenuItemList(boolean multi)

Reads the list of remove menu items.

Specified by:

getRemoveMenuItemList in interface ResultSetView

Parameters:

multi - True for multiselect

Returns:

list of remove menu items

See Also:

ResultSetView.getRemoveMenuItemList(boolean)

deleteConfiguration

public void deleteConfiguration()

Deletes the stored configuration of the columns (width and sort-direction).

Specified by:

deleteConfiguration in interface ResultSetView

See Also:

ResultSetView.deleteConfiguration()

setMaxRecords

public void setMaxRecords(int maxRecords)

Sets maximum number of records for the result set.

Parameters:

maxRecords - maximum number of records

getMaxRecords

public int getMaxRecords()

Gets maximum number of records for the result set.

Returns:

maximum number of records

setSearchMode

public void setSearchMode(SearchMode mode)

Sets the search-mode. See SearchMode for possible modes.

Specified by:

setSearchMode in interface ResultSetView

Parameters:

mode - the search mode to use

See Also:

ResultSetView.setSearchMode(com.saperion.ngc.resultset.SearchMode)

getSearchMode

public SearchMode getSearchMode()

Specified by:

getSearchMode in interface ResultSetView

Returns:

the search mode currently in use

See Also:

ResultSetView.getSearchMode()

export

public 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.

Specified by:

export in interface ResultSetView

See Also:

ResultSetView.export()

export

public void export(Map<String,String> columnsToExport,
          ResultSetView.ExportFormat format,
          String filename)

Exports the current query result. No settings-dialog will be shown.

Specified by:

export in interface ResultSetView

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

See Also:

ResultSetView.export(java.util.Map, com.saperion.ngc.resultset.ResultSetView.ExportFormat, java.lang.String)

getTotalSize

public int getTotalSize()

Returns the total size of the last query result.

Specified by:

getTotalSize in interface ResultSetView

Returns:

total size of result

See Also:

ResultSetView.getTotalSize()

setDocumentRead

@Deprecated
public void setDocumentRead(DraggableListItem item)

Deprecated. use setDocumentRead(ResultListItem) instead. Will be removed in 8.0.

Description copied from interface: ResultSetView

Sets the specified item's state to 'read' without creating a new revision.

Specified by:

setDocumentRead in interface ResultSetView

Parameters:

item - item to change

See Also:

ResultSetView.setDocumentRead(com.saperion.ngc.resultset.DraggableListItem)

setDocumentUnread

@Deprecated
public void setDocumentUnread(DraggableListItem item)

Deprecated. use setDocumentUnread(ResultListItem) instead. Will be removed in 8.0..

Description copied from interface: ResultSetView

Sets the specified item's state to 'unread' without creating a new revision.

Specified by:

setDocumentUnread in interface ResultSetView

Parameters:

item - item to change

See Also:

ResultSetView.setDocumentUnread(com.saperion.ngc.resultset.DraggableListItem)

setDocumentRead

public void setDocumentRead(ResultListItem item)

Sets the specified item's state to 'read' without creating a new revision.

Specified by:

setDocumentRead in interface ResultSetView

Parameters:

item - item to change

See Also:

ResultSetView.setDocumentRead(com.saperion.ngc.resultset.DraggableListItem)

setDocumentUnread

public void setDocumentUnread(ResultListItem item)

Sets the specified item's state to 'unread' without creating a new revision.

Specified by:

setDocumentUnread in interface ResultSetView

Parameters:

item - item to change

See Also:

ResultSetView.setDocumentUnread(com.saperion.ngc.resultset.DraggableListItem)

addCustomCondition

public void addCustomCondition(FieldResultBean condition)

Adds a condition that will be used each time this ResultSetView performs a query.

Specified by:

addCustomCondition in interface ResultSetView

Parameters:

condition - a FieldResultBean or a CustomConditionBean with the condition

See Also:

ResultSetView.addCustomCondition(com.saperion.ngc.iform.FieldResultBean)

getCustomConditions

public List<FieldResultBean> getCustomConditions()

Specified by:

getCustomConditions in interface ResultSetView

Returns:

list of all custom conditions that were added by ResultSetView.addCustomCondition(FieldResultBean). The returned list can be modified.

See Also:

ResultSetView.getCustomConditions()

setResultListClass

public void setResultListClass(Class<? extends ResultList> clazz)

Description copied from interface: ResultSetView

Sets the class that will be used for the internal ResultList. The default is ResultListImpl. The class must have a constructor with no arguments.

Specified by:

setResultListClass in interface ResultSetView

Parameters:

clazz - class to be used

setCustomSortSequences

public void setCustomSortSequences(Map<String,SortDirection> sortSequences)

Description copied from interface: ResultSetView

Sets custom sort sequences for the specified column names. These sort sequences will overwrite the sort sequences selected by the user in the UI.

Specified by:

setCustomSortSequences in interface ResultSetView

Parameters:

sortSequences - a map that maps the database-name of a column with a SortDirection

getCustomSortSequences

public Map<String,SortDirection> getCustomSortSequences()

Specified by:

getCustomSortSequences in interface ResultSetView

Returns:

the custom sort sequences set by ResultSetView.setCustomSortSequences(Map). If no custom sort sequences were set, this method returns an empty map.

onUploadSuccess

public void onUploadSuccess(org.zkoss.zk.ui.event.Event event)

Description copied from interface: ResultSetView

Handles upload success events.

Specified by:

onUploadSuccess in interface ResultSetView

Parameters:

event - event

getPropertyConverter

public PropertyToStringConverter getPropertyConverter()

Description copied from interface: ResultSetView

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.

Specified by:

getPropertyConverter in interface ResultSetView

Returns:

the property converter used by this ResultSetView