Interface IntelligentFormView

    • 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.
        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.
        Parameters:
        ddcName - DDC name
      • doCreateSysQueryMask

        @Deprecated
        void doCreateSysQueryMask​(java.lang.String ddcName)
        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.
        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 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.
        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.
      • 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 specified ButtonInfo.EventType or null, of no such button exists.
        Parameters:
        type - type of the button
        Returns:
        button for type or null if not available