com.saperion.ngc.iform

Class IntelligentFormViewImpl

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

All Implemented Interfaces:

EventChild, EventChildHandler, LogEventChildHandler, IntelligentFormView, Serializable, Cloneable, 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.ext.Framable

public class IntelligentFormViewImpl
extends BaseWindow
implements IntelligentFormView

Implementation of IntelligentFormView.

Author:

rbo

See Also:

Serialized Form

Nested Class Summary

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

org.zkoss.zul.Window.Mode

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_DEFAULT_BUTTON_CONTAINER

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 class org.zkoss.zk.ui.AbstractComponent

AFTER_PAGE_ATTACHED, AFTER_PAGE_DETACHED

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

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

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

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

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
IntelligentFormViewImpl() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addOkListenerToEditFields() Adds an ON_OK event listener to each edit field.
void	createView(com.saperion.ngc.iform.xml.Form formType) Creates the view.
void	doClearContent() Clears the view.
void	doCreateContent() Tries to open and render the mask specified by setPath.
void	doCreateSysMask(String maskDdcName) Deprecated. use createView(Form) with system form implementation from package com.saperion.ngc.iform.system instead. Will be removed with 8.1.
void	doCreateSysQueryMask(String maskDdcName) Deprecated. use createView(Form) with system form implementation from package com.saperion.ngc.iform.system instead. Will be removed with 8.1.
void	doSaveSysMask() Deprecated. this method does nothing and will be removed in 8.1
MaskInfoBean	getApplicationInfo()
List<com.saperion.ngc.iform.xml.BitmapType>	getBitmap() Returns the bitmaps defined in the form-definition.
List<com.saperion.ngc.iform.xml.ButtonType>	getButton() Returns the buttons defined in the form-definition.
FormButton	getButtonByFrameId(long frameId) Returns a button by the given frame id.
List<FormButton>	getButtons() Returns a list of all buttons contained in this form.
List<com.saperion.ngc.iform.xml.ConnectionType>	getConnection() Returns the connections defined in the form-definition.
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 specified ButtonInfo.EventType or null, of no such button exists.
org.zkoss.zk.ui.HtmlBasedComponent	getDefaultButtonContainer() Returns the container of the default-buttons.
String	getDefinitionName()
List<DocumentView>	getDocumentViews() Returns a list of all document viewers contained in this form.
List<com.saperion.ngc.iform.xml.EditFieldType>	getEditField() Returns the fields defined in the form-definition.
IntelligentField	getFieldByFrameId(long frameId) Returns a field by the given frame id.
List<IntelligentField>	getFields() Returns a list of all fields contained in this form.
com.saperion.ngc.iform.xml.Form	getForm()
FormMode	getFormMode()
List<IntelligentFormView>	getForms() Returns a list of all embedded forms contained in this form.
List<com.saperion.ngc.iform.xml.FrameType>	getFrame() Returns the frames defined in the form-definition.
List<com.saperion.ngc.iform.xml.GroupboxType>	getGroupbox() Returns the groupboxes defined in the form-definition.
List<com.saperion.ngc.iform.xml.GroupType>	getGroups() Returns the groups defined in the form-definition.
com.saperion.ngc.iform.xml.HeaderType	getHeader() Returns the header defined in the form-definition.
com.saperion.ngc.iform.xml.HiddenType	getHidden() Returns the hidden elements defined in the form-definition.
List<com.saperion.ngc.iform.xml.IncludeType>	getInclude() Returns the includes defined in the form-definition.
IndexMaskDocument	getIndexMaskDocument()
List<com.saperion.ngc.iform.xml.LabelType>	getLabel() Returns the labels defined in the form-definition.
FormLabel	getLabelByFrameId(long frameId) Returns a label by the given frame id.
List<FormLabel>	getLabels() Returns a list of all labels contained in this form.
List<FormMashup>	getMashups() Returns a list of all mashups contained in this form.
org.zkoss.zul.Tab	getParentTab() Returns the tab of MainTabView that contains this mask.
String	getPath()
List<com.saperion.ngc.iform.xml.ResultType>	getResult() Returns the ResultTypes defined in the form definition.
List<FieldResultBean>	getResultFields()
List<ResultSetView>	getResultSets() Returns a list of all resultsets contained in this form.
List<FormTabbox>	getTabBoxes() Returns a list of all tabboxes contained in this form.
List<com.saperion.ngc.iform.xml.TabListType>	getTabList() Return the TabLists defined in the form definition.
List<FormEditableImage>	getThumbnails() Returns a list of all thumbnails contained in this form.
com.saperion.ngc.iform.xml.ToolbarType	getToolbar() Returns the toolbar defined in the form-definition.
List<com.saperion.ngc.iform.xml.ViewerType>	getViewer() Returns the viewers defined in the form-definition.
String	getViewerClass() Returns the viewer class name if configured.
boolean	hasEmbeddedIndexMask() Checks if this form contains an embedded index mask.
boolean	isAutoQuery()
boolean	isQueryMask() Checks if this mask is any kind of query mask (form mode is FormMode.FOLDER_QUERY, FormMode.OUTLINER_APP_QUERY, FormMode.LOOKUP_POPUP_QUERY or FormMode.QUERY).
boolean	isSimpleMode()
void	onAddToFavorites(org.zkoss.zk.ui.event.Event event) Event handler for onAddToFavorites.
void	onButton(org.zkoss.zk.ui.event.Event event) Handler for onButton event.
void	onDisplayResultItem(org.zkoss.zk.ui.event.Event event) Display result document.
void	onDocumentFiling(org.zkoss.zk.ui.event.Event event) Event handler for onDocumentFiling.
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	onEditSelected(org.zkoss.zk.ui.event.Event event) Event handler for edit selected events.
void	onFileAction(org.zkoss.zk.ui.event.Event event) Event handler for onSelectFolder events.
void	onFilePreview(org.zkoss.zk.ui.event.Event event) Event handler for onFilePreview events.
void	onFormCreated(org.zkoss.zk.ui.event.Event 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	onOpenIndexMask(org.zkoss.zk.ui.event.Event event) Event handler for open index mask events.
void	onOpenMask(org.zkoss.zk.ui.event.Event event) Event handler for OpenMask events.
void	onOpenQueryMask(org.zkoss.zk.ui.event.Event event) Event handler for open query mask events.
void	onPageAttached(org.zkoss.zk.ui.Page newpage, org.zkoss.zk.ui.Page oldpage)
void	onPageDetached(org.zkoss.zk.ui.Page page)
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	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	setHeader(com.saperion.ngc.iform.xml.HeaderType value) Sets the header-property of the form-definition.
void	setHeight(String height)
void	setHidden(com.saperion.ngc.iform.xml.HiddenType value) Sets the hidden-property of the form-definition.
void	setPath(String pathString)
void	setSimpleMode(boolean mode) Sets the simple mode parameter for the embedded result lists.
void	setToolbar(com.saperion.ngc.iform.xml.ToolbarType value) Sets the toolbar-property of the form-definition.
void	setViewerClass(String className) Sets the name of the class to be instantiated when a viewer is used in the mask.

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, 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, setTitle, setTopmost, setVisible

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

getContext, getCtrlKeys, getPopup, getPropertyAccess, 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, getTabindex, getTabindexInteger, getTooltiptext, getTop, getVflex, getWidth, getZindex, getZIndex, setAction, setClass, setDroppable, setFocus, 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

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

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

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

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

addScopeListener, getAttribute, hasAttribute, removeAttribute, removeScopeListener, setAttribute

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

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

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

postErrorLogEvent, postErrorLogEvent, postInfoLogEvent, postInfoLogEvent, postWarningLogEvent, postWarningLogEvent

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

getEventtarget, setEventtarget

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

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

Field Detail

CLASS_DEFAULT_BUTTON_CONTAINER

public static final String CLASS_DEFAULT_BUTTON_CONTAINER

See Also:

Constant Field Values

Constructor Detail

IntelligentFormViewImpl

public IntelligentFormViewImpl()

Constructor.

Method Detail

createView

public void createView(com.saperion.ngc.iform.xml.Form formType)
                throws NgcUiException

Creates the view.

Specified by:

createView in interface IntelligentFormView

Parameters:

formType - Form object

Throws:

NgcUiException - exception to be handled by view

See Also:

IntelligentFormView.createView(com.saperion.ngc.iform.xml.Form)

saveFormLayout

public void saveFormLayout()

Saves the layout of the form for the current user.

Specified by:

saveFormLayout in interface IntelligentFormView

See Also:

IntelligentFormView.saveFormLayout()

isAutoQuery

public boolean isAutoQuery()

Returns:

Is auto query

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

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:

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

onButton

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

Handler for onButton event.

Parameters:

event - Event

onIndexChange

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

Handle index change event.

Specified by:

onIndexChange in interface IntelligentFormView

Parameters:

event - Event

See Also:

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

onDocumentLocked

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

Handle lock/unlock of an document.

Specified by:

onDocumentLocked in interface IntelligentFormView

Parameters:

event - Event

See Also:

IntelligentFormView.onDocumentLocked(org.zkoss.zk.ui.event.Event)

onEditSelected

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

Event handler for edit selected events.

Parameters:

event - event

onOpenIndexMask

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

Event handler for open index mask events.

Parameters:

event - event

onOpenQueryMask

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

Event handler for open query mask events.

Parameters:

event - event

onSelectDDC

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

onSelectDDC event handler.

Specified by:

onSelectDDC in interface IntelligentFormView

Parameters:

event - Event

See Also:

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

onNavigationForm

public final void onNavigationForm(org.zkoss.zk.ui.event.Event event)

Handle navigation form event.

Specified by:

onNavigationForm in interface IntelligentFormView

Parameters:

event - Event

See Also:

IntelligentFormView.onNavigationForm(org.zkoss.zk.ui.event.Event)

onUploadDocument

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

Handle upload document event.

Specified by:

onUploadDocument in interface IntelligentFormView

Parameters:

event - event

See Also:

IntelligentFormView.onUploadDocument(org.zkoss.zk.ui.event.Event)

onUploadSuccess

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

Description copied from interface: IntelligentFormView

Handles upload success events.

Specified by:

onUploadSuccess in interface IntelligentFormView

Parameters:

event - Event

onEditFolder

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

Handles onEditFolder event.

Specified by:

onEditFolder in interface IntelligentFormView

Parameters:

event - event

See Also:

IntelligentFormView.onEditFolder(org.zkoss.zk.ui.event.Event)

onNewItem

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

Handles onNewitem event.

Specified by:

onNewItem in interface IntelligentFormView

Parameters:

event - event

See Also:

IntelligentFormView.onNewItem(org.zkoss.zk.ui.event.Event)

onEditItem

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

Handles onEditItem event.

Specified by:

onEditItem in interface IntelligentFormView

Parameters:

event - event

See Also:

IntelligentFormView.onEditItem(org.zkoss.zk.ui.event.Event)

onFilePreview

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

Event handler for onFilePreview events.

Parameters:

event - event

onDocumentFiling

public final void onDocumentFiling(org.zkoss.zk.ui.event.Event event)

Event handler for onDocumentFiling.

Parameters:

event - event

onAddToFavorites

public final void onAddToFavorites(org.zkoss.zk.ui.event.Event event)

Event handler for onAddToFavorites.

Parameters:

event - event

onNavigationFolder

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

Handle navigation folder event.

Specified by:

onNavigationFolder in interface IntelligentFormView

Parameters:

event - Event

onLogon

public final void onLogon(org.zkoss.zk.ui.event.Event event)

Event handler for Logon events.

Specified by:

onLogon in interface IntelligentFormView

Parameters:

event - event

onOpenMask

public final void onOpenMask(org.zkoss.zk.ui.event.Event event)

Event handler for OpenMask events.

Specified by:

onOpenMask in interface IntelligentFormView

Parameters:

event - event

onDisplayResultItem

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

Display result document.

Specified by:

onDisplayResultItem in interface IntelligentFormView

Parameters:

event - Event

See Also:

IntelligentFormView.onDisplayResultItem(org.zkoss.zk.ui.event.Event)

onResetGui

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

Handles reset gui event.

Specified by:

onResetGui in interface IntelligentFormView

Parameters:

event - ZK event

onQueryFavorite

public final void onQueryFavorite(org.zkoss.zk.ui.event.Event event)

Event handler for QueryFavorite events.

Specified by:

onQueryFavorite in interface IntelligentFormView

Parameters:

event - event

onFileAction

public final void onFileAction(org.zkoss.zk.ui.event.Event event)

Event handler for onSelectFolder events.

Parameters:

event - event

onFormCreated

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

doCreateContent

public void doCreateContent()

Tries to open and render the mask specified by setPath.

Specified by:

doCreateContent in interface IntelligentFormView

See Also:

IntelligentFormView.doCreateContent()

doClearContent

public void doClearContent()

Clears the view.

Specified by:

doClearContent in interface IntelligentFormView

See Also:

IntelligentFormView.doClearContent()

doCreateSysMask

@Deprecated
public void doCreateSysMask(String maskDdcName)

Deprecated. use createView(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.

Specified by:

doCreateSysMask in interface IntelligentFormView

Parameters:

maskDdcName - DDC name

See Also:

IntelligentFormView.doCreateSysMask(java.lang.String)

doCreateSysQueryMask

@Deprecated
public void doCreateSysQueryMask(String maskDdcName)

Deprecated. use createView(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.

Specified by:

doCreateSysQueryMask in interface IntelligentFormView

Parameters:

maskDdcName - DDC name

See Also:

IntelligentFormView.doCreateSysQueryMask(java.lang.String)

doSaveSysMask

@Deprecated
public void doSaveSysMask()

Deprecated. this method does nothing and will be removed in 8.1

Specified by:

doSaveSysMask in interface IntelligentFormView

See Also:

IntelligentFormView.doSaveSysMask()

getPath

public String getPath()

Returns:

Path

setPath

public void setPath(String pathString)

Parameters:

pathString - Path to QBE file

getResultFields

public List<FieldResultBean> getResultFields()

Returns:

List of beans of all fields

getDefinitionName

public String getDefinitionName()

Specified by:

getDefinitionName in interface IntelligentFormView

Returns:

the definition name

addOkListenerToEditFields

public void addOkListenerToEditFields()

Adds an ON_OK event listener to each edit field.

Specified by:

addOkListenerToEditFields in interface IntelligentFormView

getBitmap

public List<com.saperion.ngc.iform.xml.BitmapType> getBitmap()

Returns the bitmaps defined in the form-definition.

Returns:

list of BitmapType

See Also:

Form.getBitmap()

getButton

public List<com.saperion.ngc.iform.xml.ButtonType> getButton()

Returns the buttons defined in the form-definition.

Returns:

list of ButtonType

See Also:

Form.getButton()

getConnection

public List<com.saperion.ngc.iform.xml.ConnectionType> getConnection()

Returns the connections defined in the form-definition.

Returns:

list of ConnectionType

See Also:

Form.getConnection()

getEditField

public List<com.saperion.ngc.iform.xml.EditFieldType> getEditField()

Returns the fields defined in the form-definition.

Returns:

list of EditFieldType

See Also:

Form.getEditField()

getFrame

public List<com.saperion.ngc.iform.xml.FrameType> getFrame()

Returns the frames defined in the form-definition.

Returns:

list of FrameType

See Also:

Form.getFrame()

getGroupbox

public List<com.saperion.ngc.iform.xml.GroupboxType> getGroupbox()

Returns the groupboxes defined in the form-definition.

Returns:

list of GroupboxType

See Also:

Form.getGroupbox()

getGroups

public List<com.saperion.ngc.iform.xml.GroupType> getGroups()

Returns the groups defined in the form-definition.

Returns:

list of GroupType

See Also:

Form.getGroups()

getHeader

public com.saperion.ngc.iform.xml.HeaderType getHeader()

Returns the header defined in the form-definition.

Returns:

HeaderType

See Also:

Form.getHeader()

getHidden

public com.saperion.ngc.iform.xml.HiddenType getHidden()

Returns the hidden elements defined in the form-definition.

Returns:

HiddenType

See Also:

Form.getHidden()

getInclude

public List<com.saperion.ngc.iform.xml.IncludeType> getInclude()

Returns the includes defined in the form-definition.

Returns:

list of IncludeType

See Also:

Form.getInclude()

getLabel

public List<com.saperion.ngc.iform.xml.LabelType> getLabel()

Returns the labels defined in the form-definition.

Returns:

list of LabelType

See Also:

Form.getLabel()

getResult

public List<com.saperion.ngc.iform.xml.ResultType> getResult()

Returns the ResultTypes defined in the form definition.

Returns:

list of ResultType

See Also:

Form.getResult()

getTabList

public List<com.saperion.ngc.iform.xml.TabListType> getTabList()

Return the TabLists defined in the form definition.

Returns:

List of TabListType

See Also:

Form.getTabList()

getToolbar

public com.saperion.ngc.iform.xml.ToolbarType getToolbar()

Returns the toolbar defined in the form-definition.

Returns:

toolbar

See Also:

Form.getToolbar()

getViewer

public List<com.saperion.ngc.iform.xml.ViewerType> getViewer()

Returns the viewers defined in the form-definition.

Returns:

list of ViewerType

See Also:

Form.getViewer()

setHeader

public void setHeader(com.saperion.ngc.iform.xml.HeaderType value)

Sets the header-property of the form-definition.

Parameters:

value - property value

See Also:

Form.setHeader(com.saperion.ngc.iform.xml.HeaderType)

setHidden

public void setHidden(com.saperion.ngc.iform.xml.HiddenType value)

Sets the hidden-property of the form-definition.

Parameters:

value - property value

See Also:

Form.setHidden(com.saperion.ngc.iform.xml.HiddenType)

setToolbar

public void setToolbar(com.saperion.ngc.iform.xml.ToolbarType value)

Sets the toolbar-property of the form-definition.

Parameters:

value - property value

See Also:

Form.setToolbar(com.saperion.ngc.iform.xml.ToolbarType)

isSimpleMode

public boolean isSimpleMode()

Specified by:

isSimpleMode in interface IntelligentFormView

Returns:

simple mode parameter value

See Also:

IntelligentFormView.isSimpleMode()

setSimpleMode

public void setSimpleMode(boolean mode)

Sets the simple mode parameter for the embedded result lists.

Specified by:

setSimpleMode in interface IntelligentFormView

Parameters:

mode - parameter value

See Also:

IntelligentFormView.setSimpleMode(boolean)

setHeight

public void setHeight(String height)

Overrides:

setHeight in class org.zkoss.zk.ui.HtmlBasedComponent

See Also:

HtmlBasedComponent.setHeight(java.lang.String)

getFields

public List<IntelligentField> getFields()

Returns a list of all fields contained in this form.

Specified by:

getFields in interface IntelligentFormView

Returns:

list of fields.

See Also:

IntelligentFormView.getFields()

getFieldByFrameId

public IntelligentField getFieldByFrameId(long frameId)

Returns a field by the given frame id.

Specified by:

getFieldByFrameId in interface IntelligentFormView

Parameters:

frameId - the frame of the field (as generated in the mask editor)-

Returns:

the field if existing.

See Also:

IntelligentFormView.getFieldByFrameId(long)

getButtons

public List<FormButton> getButtons()

Returns a list of all buttons contained in this form.

Specified by:

getButtons in interface IntelligentFormView

Returns:

list of buttons

See Also:

IntelligentFormView.getButtons()

getButtonByFrameId

public FormButton getButtonByFrameId(long frameId)

Returns a button by the given frame id.

Specified by:

getButtonByFrameId in interface IntelligentFormView

Parameters:

frameId - the frame of the button (as generated in the mask editor)-

Returns:

the button if existing.

See Also:

IntelligentFormView.getButtonByFrameId(long)

getLabels

public List<FormLabel> getLabels()

Returns a list of all labels contained in this form.

Specified by:

getLabels in interface IntelligentFormView

Returns:

See Also:

IntelligentFormView.getLabels()

getLabelByFrameId

public FormLabel getLabelByFrameId(long frameId)

Returns a label by the given frame id.

Specified by:

getLabelByFrameId in interface IntelligentFormView

Parameters:

frameId - the frame of the label (as generated in the mask editor)-

Returns:

the label if existing.

See Also:

IntelligentFormView.getLabelByFrameId(long)

getResultSets

public List<ResultSetView> getResultSets()

Returns a list of all resultsets contained in this form.

Specified by:

getResultSets in interface IntelligentFormView

Returns:

list of resultsets

See Also:

IntelligentFormView.getResultSets()

getDocumentViews

public List<DocumentView> getDocumentViews()

Returns a list of all document viewers contained in this form.

Specified by:

getDocumentViews in interface IntelligentFormView

Returns:

list of document viewers

See Also:

IntelligentFormView.getDocumentViews()

getMashups

public List<FormMashup> getMashups()

Returns a list of all mashups contained in this form.

Specified by:

getMashups in interface IntelligentFormView

Returns:

list of mashups

See Also:

IntelligentFormView.getMashups()

getForms

public List<IntelligentFormView> getForms()

Returns a list of all embedded forms contained in this form.

Specified by:

getForms in interface IntelligentFormView

Returns:

list of forms

See Also:

IntelligentFormView.getForms()

getThumbnails

public List<FormEditableImage> getThumbnails()

Returns a list of all thumbnails contained in this form.

Specified by:

getThumbnails in interface IntelligentFormView

Returns:

list of thumbnails

See Also:

IntelligentFormView.getThumbnails()

getTabBoxes

public List<FormTabbox> getTabBoxes()

Returns a list of all tabboxes contained in this form.

Specified by:

getTabBoxes in interface IntelligentFormView

Returns:

list of tabboxes

See Also:

IntelligentFormView.getTabBoxes()

getFormMode

public FormMode getFormMode()

Specified by:

getFormMode in interface IntelligentFormView

Returns:

the mode the IntelligentFormView currently is in.

See Also:

IntelligentFormView.getFormMode()

setFormMode

public void setFormMode(FormMode mode)

Sets the mode of the form.

Specified by:

setFormMode in interface IntelligentFormView

Parameters:

mode - new mode

See Also:

IntelligentFormView.setFormMode(com.saperion.ngc.iform.FormMode)

getCurrentUploadInfos

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

Specified by:

getCurrentUploadInfos in interface IntelligentFormView

Returns:

folder upload infos

See Also:

IntelligentFormView.getCurrentUploadInfos()

getCurrentFolderSearchInfos

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

Specified by:

getCurrentFolderSearchInfos in interface IntelligentFormView

Returns:

folder search infos

See Also:

IntelligentFormView.getCurrentFolderSearchInfos()

getForm

public com.saperion.ngc.iform.xml.Form getForm()

Specified by:

getForm in interface IntelligentFormView

Returns:

the form definition containing all information used to render the current form

See Also:

IntelligentFormView.getForm()

hasEmbeddedIndexMask

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

Specified by:

hasEmbeddedIndexMask in interface IntelligentFormView

Returns:

true if this mask contains an embedded index mask to edit a document's index data.

See Also:

IntelligentFormView.hasEmbeddedIndexMask()

getApplicationInfo

public MaskInfoBean getApplicationInfo()

Specified by:

getApplicationInfo in interface IntelligentFormView

Returns:

information about the application node that was used to open this mask, if available

See Also:

IntelligentFormView.getApplicationInfo()

setViewerClass

public void setViewerClass(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.

Specified by:

setViewerClass in interface IntelligentFormView

Parameters:

className - class name

See Also:

IntelligentFormView.setViewerClass(java.lang.String)

getViewerClass

public String getViewerClass()

Returns the viewer class name if configured. If the value was not set for this form, this method returns null.

Specified by:

getViewerClass in interface IntelligentFormView

Returns:

viewer class name or null if not set

See Also:

IntelligentFormView.getViewerClass()

getParentTab

public org.zkoss.zul.Tab getParentTab()

Returns the tab of MainTabView that contains this mask. If this mask is not contained in a tab (embedded mask or opened as popup...) this method returns null.

Specified by:

getParentTab in interface IntelligentFormView

Returns:

parent Tab or null if not contained in a tab

See Also:

IntelligentFormView.getParentTab()

resetMask

public void resetMask()

Deletes the stored layout for the mask and re-creates the content.

Specified by:

resetMask in interface IntelligentFormView

See Also:

IntelligentFormView.resetMask()

getIndexMaskDocument

public IndexMaskDocument getIndexMaskDocument()

Specified by:

getIndexMaskDocument in interface IntelligentFormView

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.

See Also:

IntelligentFormView.getIndexMaskDocument()

isQueryMask

public boolean isQueryMask()

Checks if this mask is any kind of query mask (form mode is FormMode.FOLDER_QUERY, FormMode.OUTLINER_APP_QUERY, FormMode.LOOKUP_POPUP_QUERY or FormMode.QUERY).

Specified by:

isQueryMask in interface IntelligentFormView

Returns:

true if this mask is a query-mask

See Also:

IntelligentFormView.isQueryMask()

getDefaultButtonContainer

public org.zkoss.zk.ui.HtmlBasedComponent getDefaultButtonContainer()

Returns the container of the default-buttons.

Specified by:

getDefaultButtonContainer in interface IntelligentFormView

Returns:

container of the default-buttons

See Also:

IntelligentFormView.getDefaultButtonContainer()

getDefaultButton

public org.zkoss.zul.Button getDefaultButton(ButtonInfo.EventType type)

Returns the default-button for the specified ButtonInfo.EventType or null, of no such button exists.

Specified by:

getDefaultButton in interface IntelligentFormView

Parameters:

type - type of the button

Returns:

button for type or null if not available

See Also:

(com.saperion.ngc.iform.button.ButtonInfo.EventType)