Package com.saperion.ngc.iform
Interface IntelligentFormView
-
- All Superinterfaces:
java.lang.Cloneable
,org.zkoss.zk.ui.Component
,EventChild
,EventChildHandler
,LogEventChildHandler
,org.zkoss.zk.ui.ext.Scope
,java.io.Serializable
- All Known Implementing Classes:
IntelligentFormViewImpl
public interface IntelligentFormView extends org.zkoss.zk.ui.Component, EventChild, EventChildHandler
The IntelligentFormView represents a Saperion form in the WebClient. Scripts can listen to theonFormCreated
event to perform actions after the form and all of it's children were created.- See Also:
EventChild.ON_FORM_CREATED
-
-
Field Summary
-
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_PROLONG_RETENTION, ON_DOCUMENT_REDUCE_DISPOSITION, 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_EXTERNAL_STORAGE_UPLOAD, ON_EXTERNAL_STORAGE_UPLOAD_STATUS, 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_ONEDRIVE_LOGIN, 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_SET_LITIGATION_HOLD, ON_SHAREBASE_DOCUMENT_CHECK, ON_SHAREBASE_LOGIN, ON_START_WORKFLOW, ON_TAB_SELECTED, ON_UNDELETE_SELECTED, ON_UPLOAD_DOCUMENT, ON_UPLOAD_EXTERNAL_STORAGE_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, ON_WORKFLOW_DISPLAY_COMMENT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
addOkListenerToEditFields()
Adds an ON_OK event listener to each edit field.void
createView(com.saperion.ngc.iform.xml.Form form)
Creates the view.void
doClearContent()
Clears the view.void
doCreateContent()
Tries to open and render the mask specified by setPath.void
doCreateSysMask(java.lang.String ddcName)
Deprecated.usecreateView(Form)
with system form implementation from package com.saperion.ngc.iform.system instead.void
doCreateSysQueryMask(java.lang.String ddcName)
Deprecated.usecreateView(Form)
with system form implementation from package com.saperion.ngc.iform.system instead.void
doSaveSysMask()
Deprecated.this method does nothing and will be removed in 8.1MaskInfoBean
getApplicationInfo()
FormButton
getButtonByFrameId(long frameId)
Returns a button by the given frame id.java.util.List<FormButton>
getButtons()
Returns a list of all buttons contained in this form.FolderSearchInfos
getCurrentFolderSearchInfos()
If the form is used to display the content of a folder or a file, this method returns information about the folder or file in use.FolderUploadInfos
getCurrentUploadInfos()
If the form is used as an index form for a new document, this method returns information about this upload process.org.zkoss.zul.Button
getDefaultButton(ButtonInfo.EventType type)
Returns the default-button for the specifiedButtonInfo.EventType
or null, of no such button exists.org.zkoss.zk.ui.HtmlBasedComponent
getDefaultButtonContainer()
Returns the container of the default-buttons.java.lang.String
getDefinitionName()
java.util.List<DocumentView>
getDocumentViews()
Returns a list of all document viewers contained in this form.IntelligentField
getFieldByFrameId(long frameId)
Returns a field by the given frame id.java.util.List<IntelligentField>
getFields()
Returns a list of all fields contained in this form.com.saperion.ngc.iform.xml.Form
getForm()
FormMode
getFormMode()
java.util.List<IntelligentFormView>
getForms()
Returns a list of all embedded forms contained in this form.IndexMaskDocument
getIndexMaskDocument()
FormLabel
getLabelByFrameId(long frameId)
Returns a label by the given frame id.java.util.List<FormLabel>
getLabels()
Returns a list of all labels contained in this form.java.util.List<FormMashup>
getMashups()
Returns a list of all mashups contained in this form.org.zkoss.zul.Tab
getParentTab()
Returns the tab ofMainTabView
that contains this mask.java.util.List<ResultSetView>
getResultSets()
Returns a list of all resultsets contained in this form.java.util.List<FormTabbox>
getTabBoxes()
Returns a list of all tabboxes contained in this form.java.util.List<FormEditableImage>
getThumbnails()
Returns a list of all thumbnails contained in this form.java.lang.String
getViewerClass()
Returns the viewer class name if configured.boolean
hasEmbeddedIndexMask()
Checks if this form contains an embedded index mask.boolean
isQueryMask()
Checks if this mask is any kind of query mask (form mode isFormMode.FOLDER_QUERY
,FormMode.OUTLINER_APP_QUERY
,FormMode.LOOKUP_POPUP_QUERY
orFormMode.QUERY
).boolean
isSimpleMode()
void
onDisplayResultItem(org.zkoss.zk.ui.event.Event event)
Display result document.void
onDocumentLocked(org.zkoss.zk.ui.event.Event event)
Handle lock/unlock of an document.void
onEditFolder(org.zkoss.zk.ui.event.Event event)
Handles onEditFolder event.void
onEditItem(org.zkoss.zk.ui.event.Event event)
Handles onEditItem event.void
onIndexChange(org.zkoss.zk.ui.event.Event event)
Handle index change event.void
onLogon(org.zkoss.zk.ui.event.Event event)
Event handler for Logon events.void
onNavigationFolder(org.zkoss.zk.ui.event.Event event)
Handle navigation folder event.void
onNavigationForm(org.zkoss.zk.ui.event.Event event)
Handle navigation form event.void
onNewItem(org.zkoss.zk.ui.event.Event event)
Handles onNewitem event.void
onOpenMask(org.zkoss.zk.ui.event.Event event)
Event handler for OpenMask events.void
onQueryFavorite(org.zkoss.zk.ui.event.Event event)
Event handler for QueryFavorite events.void
onResetGui(org.zkoss.zk.ui.event.Event event)
Handles reset gui event.void
onSelectDDC(org.zkoss.zk.ui.event.Event event)
onSelectDDC event handler.void
onUploadDocument(org.zkoss.zk.ui.event.Event event)
Handle upload document event.void
onUploadExternalStorageDocument(org.zkoss.zk.ui.event.Event event)
Handle upload External Storage document event.void
onUploadSuccess(org.zkoss.zk.ui.event.Event event)
Handles upload success events.void
resetMask()
Deletes the stored layout for the mask and re-creates the content.void
saveFormLayout()
Saves the layout of the form for the current user.void
setFormMode(FormMode mode)
Sets the mode of the form.void
setSimpleMode(boolean mode)
Sets the simple mode parameter for the embedded result lists.void
setViewerClass(java.lang.String className)
Sets the name of the class to be instantiated when a viewer is used in the mask.-
Methods inherited from interface org.zkoss.zk.ui.Component
addEventListener, addEventListener, addForward, addForward, addForward, addForward, appendChild, applyProperties, clone, detach, getAttribute, getAttribute, getAttributeOrFellow, getAttributes, getAttributes, getAuService, getAutag, getChildren, getClientAttribute, getClientDataAttribute, getDefinition, getDesktop, getEventListeners, getFellow, getFellow, getFellowIfAny, getFellowIfAny, getFellows, getFirstChild, getId, getLastChild, getListenerIterator, getMold, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, getShadowVariable, getShadowVariable, getSpaceOwner, getStubonly, getTemplate, getTemplateNames, getUuid, getWidgetAttribute, getWidgetAttributeNames, getWidgetClass, getWidgetListener, getWidgetListenerNames, getWidgetOverride, getWidgetOverrideNames, hasAttribute, hasAttribute, hasAttributeOrFellow, hasFellow, hasFellow, insertBefore, invalidate, isInvalidated, isListenerAvailable, isVisible, query, queryAll, removeAttribute, removeAttribute, removeChild, removeEventListener, removeForward, removeForward, setAttribute, setAttribute, setAuService, setAutag, setClientAttribute, setClientDataAttribute, setId, setMold, setPage, setPageBefore, setParent, setStubonly, setStubonly, setTemplate, setVisible, setWidgetAttribute, setWidgetClass, setWidgetListener, setWidgetOverride
-
Methods inherited from interface com.saperion.ngc.events.EventChild
getEventtarget, setEventtarget
-
Methods inherited from interface com.saperion.ngc.events.EventChildHandler
postAddLinkEvent, postAddToFavoritesEvent, postCancelSelectedEvent, postChangeDocumentSecurityEvent, postChangeFolderSecurityEvent, postDeleteSelectedEvent, postDisplayPopupEvent, postDisplayPopupEvent, postDisplayPopupEvent, postDisplayResultItemEvent, postDisplayResultItemEvent, postDocumentCheckEvent, postDocumentCheckWithShareBaseEvent, postDocumentFilingEvent, postDocumentFilingEvent, postDocumentReleaseEvent, postDownloadResultItemEvent, postEditContentEvent, postEditItemSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditSelectedEvent, postEditStructureEvent, postExternalStorageUploadEvent, postExternalStorageUploadStatusEvent, postFieldChangeEvent, postFileActionEvent, postFileActionEvent, postFormButtonEvent, postIndexResultItemEvent, postLaunchWorkflowEvent, postLockDocumentEvent, postLogonEvent, postLogonEvent, postNavigationFolderEvent, postNavigationFormEvent, postNavigationFormEvent, postNavigationWebpartEvent, postNewSelectedEvent, postOpenMaskEvent, postPrintDocumentEvent, postProlongRetentionEvent, postQueryFavoriteEvent, postReduceDispositionEvent, postRefreshEvent, postResetGuiEvent, postResultFieldEvent, postSaveDocumentEvent, postSaveDocumentEvent, postSelectTreeItemEvent, postSendMailResultItemEvent, postSetLitigationHoldEvent, postShareBaseLoginEvent, postStartWorkflowEvent, postTabSelectedEvent, postUnDeleteSelectedEvent, postUploadDocumentEvent, postUploadeExternalStorageDocumentEvent, postUploadSuccessEvent, postWorkflowActionEvent, postWorkflowCommentEvent, postWorkflowDisplayCommentEvent
-
Methods inherited from interface com.saperion.ngc.events.LogEventChildHandler
postErrorLogEvent, postErrorLogEvent, postInfoLogEvent, postInfoLogEvent, postWarningLogEvent, postWarningLogEvent
-
-
-
-
Method Detail
-
doCreateContent
void doCreateContent()
Tries to open and render the mask specified by setPath.
-
doClearContent
void doClearContent()
Clears the view.
-
createView
void createView(com.saperion.ngc.iform.xml.Form form) throws NgcUiException
Creates the view.- Parameters:
form
- Form object- Throws:
NgcUiException
- exception to be handled by view
-
doCreateSysMask
@Deprecated void doCreateSysMask(java.lang.String ddcName)
Deprecated.usecreateView(Form)
with system form implementation from package com.saperion.ngc.iform.system instead. Will be removed with 8.1.Creates a system-index form for the specified DDC.- Parameters:
ddcName
- DDC name
-
doCreateSysQueryMask
@Deprecated void doCreateSysQueryMask(java.lang.String ddcName)
Deprecated.usecreateView(Form)
with system form implementation from package com.saperion.ngc.iform.system instead. Will be removed with 8.1.Creates a system-query form for the specified DDC.- Parameters:
ddcName
- DDC name
-
doSaveSysMask
@Deprecated void doSaveSysMask()
Deprecated.this method does nothing and will be removed in 8.1
-
getDefinitionName
java.lang.String getDefinitionName()
- Returns:
- the definition name
-
addOkListenerToEditFields
void addOkListenerToEditFields()
Adds an ON_OK event listener to each edit field.
-
onSelectDDC
void onSelectDDC(org.zkoss.zk.ui.event.Event event)
onSelectDDC event handler.- Parameters:
event
- Event
-
onNavigationForm
void onNavigationForm(org.zkoss.zk.ui.event.Event event)
Handle navigation form event.- Parameters:
event
- Event
-
onNavigationFolder
void onNavigationFolder(org.zkoss.zk.ui.event.Event event)
Handle navigation folder event.- Parameters:
event
- Event
-
onUploadDocument
void onUploadDocument(org.zkoss.zk.ui.event.Event event)
Handle upload document event.- Parameters:
event
- event
-
onUploadExternalStorageDocument
void onUploadExternalStorageDocument(org.zkoss.zk.ui.event.Event event)
Handle upload External Storage document event.- Parameters:
event
- event
-
onIndexChange
void onIndexChange(org.zkoss.zk.ui.event.Event event)
Handle index change event.- Parameters:
event
- Event
-
onDocumentLocked
void onDocumentLocked(org.zkoss.zk.ui.event.Event event)
Handle lock/unlock of an document.- Parameters:
event
- Event
-
onDisplayResultItem
void onDisplayResultItem(org.zkoss.zk.ui.event.Event event)
Display result document.- Parameters:
event
- Event
-
onResetGui
void onResetGui(org.zkoss.zk.ui.event.Event event)
Handles reset gui event.- Parameters:
event
- ZK event
-
onUploadSuccess
void onUploadSuccess(org.zkoss.zk.ui.event.Event event)
Handles upload success events.- Parameters:
event
- Event
-
onEditFolder
void onEditFolder(org.zkoss.zk.ui.event.Event event)
Handles onEditFolder event.- Parameters:
event
- event
-
onNewItem
void onNewItem(org.zkoss.zk.ui.event.Event event)
Handles onNewitem event.- Parameters:
event
- event
-
onEditItem
void onEditItem(org.zkoss.zk.ui.event.Event event)
Handles onEditItem event.- Parameters:
event
- event
-
setSimpleMode
void setSimpleMode(boolean mode)
Sets the simple mode parameter for the embedded result lists.- Parameters:
mode
- parameter value
-
isSimpleMode
boolean isSimpleMode()
- Returns:
- simple mode parameter value
-
getFields
java.util.List<IntelligentField> getFields()
Returns a list of all fields contained in this form.- Returns:
- list of fields.
-
getFieldByFrameId
IntelligentField getFieldByFrameId(long frameId)
Returns a field by the given frame id.- Parameters:
frameId
- the frame of the field (as generated in the mask editor)-- Returns:
- the field if existing.
-
getButtons
java.util.List<FormButton> getButtons()
Returns a list of all buttons contained in this form.- Returns:
- list of buttons
-
getButtonByFrameId
FormButton getButtonByFrameId(long frameId)
Returns a button by the given frame id.- Parameters:
frameId
- the frame of the button (as generated in the mask editor)-- Returns:
- the button if existing.
-
getLabels
java.util.List<FormLabel> getLabels()
Returns a list of all labels contained in this form.- Returns:
-
getLabelByFrameId
FormLabel getLabelByFrameId(long frameId)
Returns a label by the given frame id.- Parameters:
frameId
- the frame of the label (as generated in the mask editor)-- Returns:
- the label if existing.
-
getResultSets
java.util.List<ResultSetView> getResultSets()
Returns a list of all resultsets contained in this form.- Returns:
- list of resultsets
-
getDocumentViews
java.util.List<DocumentView> getDocumentViews()
Returns a list of all document viewers contained in this form.- Returns:
- list of document viewers
-
getMashups
java.util.List<FormMashup> getMashups()
Returns a list of all mashups contained in this form.- Returns:
- list of mashups
-
getForms
java.util.List<IntelligentFormView> getForms()
Returns a list of all embedded forms contained in this form.- Returns:
- list of forms
-
getThumbnails
java.util.List<FormEditableImage> getThumbnails()
Returns a list of all thumbnails contained in this form.- Returns:
- list of thumbnails
-
getTabBoxes
java.util.List<FormTabbox> getTabBoxes()
Returns a list of all tabboxes contained in this form.- Returns:
- list of tabboxes
-
getFormMode
FormMode getFormMode()
- Returns:
- the mode the IntelligentFormView currently is in.
-
setFormMode
void setFormMode(FormMode mode)
Sets the mode of the form.- Parameters:
mode
- new mode
-
getCurrentUploadInfos
FolderUploadInfos getCurrentUploadInfos()
If the form is used as an index form for a new document, this method returns information about this upload process. Otherwise the method returns null.- Returns:
- folder upload infos
-
getCurrentFolderSearchInfos
FolderSearchInfos getCurrentFolderSearchInfos()
If the form is used to display the content of a folder or a file, this method returns information about the folder or file in use. Otherwise the method returns null.- Returns:
- folder search infos
-
onQueryFavorite
void onQueryFavorite(org.zkoss.zk.ui.event.Event event)
Event handler for QueryFavorite events.- Parameters:
event
- event
-
onOpenMask
void onOpenMask(org.zkoss.zk.ui.event.Event event)
Event handler for OpenMask events.- Parameters:
event
- event
-
onLogon
void onLogon(org.zkoss.zk.ui.event.Event event)
Event handler for Logon events.- Parameters:
event
- event
-
getForm
com.saperion.ngc.iform.xml.Form getForm()
- Returns:
- the form definition containing all information used to render the current form
-
hasEmbeddedIndexMask
boolean hasEmbeddedIndexMask()
Checks if this form contains an embedded index mask. Returns true only if the mask's definition name matches the definition name of the parent-mask.- Returns:
- true if this mask contains an embedded index mask to edit a document's index data.
-
getApplicationInfo
MaskInfoBean getApplicationInfo()
- Returns:
- information about the application node that was used to open this mask, if available
-
setViewerClass
void setViewerClass(java.lang.String className)
Sets the name of the class to be instantiated when a viewer is used in the mask. Overrides the setting in web.xml.- Parameters:
className
- class name
-
getViewerClass
java.lang.String getViewerClass()
Returns the viewer class name if configured. If the value was not set for this form, this method returns null.- Returns:
- viewer class name or null if not set
-
getParentTab
org.zkoss.zul.Tab getParentTab()
Returns the tab ofMainTabView
that contains this mask. If this mask is not contained in a tab (embedded mask or opened as popup...) this method returns null.- Returns:
- parent
Tab
or null if not contained in a tab
-
saveFormLayout
void saveFormLayout()
Saves the layout of the form for the current user.
-
resetMask
void resetMask()
Deletes the stored layout for the mask and re-creates the content.
-
getIndexMaskDocument
IndexMaskDocument getIndexMaskDocument()
- Returns:
- an
IndexMaskDocument
containing information about the document that is in use in this mask. This method can only be used when this is an index-mask.
-
isQueryMask
boolean isQueryMask()
Checks if this mask is any kind of query mask (form mode isFormMode.FOLDER_QUERY
,FormMode.OUTLINER_APP_QUERY
,FormMode.LOOKUP_POPUP_QUERY
orFormMode.QUERY
).- Returns:
- true if this mask is a query-mask
-
getDefaultButtonContainer
org.zkoss.zk.ui.HtmlBasedComponent getDefaultButtonContainer()
Returns the container of the default-buttons.- Returns:
- container of the default-buttons
-
getDefaultButton
org.zkoss.zul.Button getDefaultButton(ButtonInfo.EventType type)
Returns the default-button for the specifiedButtonInfo.EventType
or null, of no such button exists.- Parameters:
type
- type of the button- Returns:
- button for type or null if not available
-
-