Class HTMLPage

  • All Implemented Interfaces:
    java.io.Serializable

    public final class HTMLPage
    extends HTMLTool
    implements java.io.Serializable
    HTML page service
    See Also:
    Serialized Form
    • Field Detail

      • YES

        public java.lang.String YES
        Yes translation
      • NO

        public java.lang.String NO
        No translation
    • Constructor Detail

      • HTMLPage

        public HTMLPage​(javax.servlet.http.HttpSession session)
        Constructor
        Parameters:
        session - Session
    • Method Detail

      • getSession

        public javax.servlet.http.HttpSession getSession()
        Session
        Returns:
        session
      • getDisposition

        public java.lang.String getDisposition()
        Get disposition
        Returns:
        Disposition
      • getGrant

        public Grant getGrant()
        Get user rights
        Returns:
        user rights
      • setGrant

        public void setGrant​(Grant g)
        Set user rights
        Parameters:
        g - User rights (grant)
      • getObjectSearch

        public com.simplicite.webapp.ObjectSearch getObjectSearch()
        Get object search manager
        Returns:
        Object search manager
      • getObjectList

        public com.simplicite.webapp.ObjectList getObjectList()
        Get object list manager
        Returns:
        Object list manager
      • getObjectForm

        public com.simplicite.webapp.ObjectForm getObjectForm()
        Get object form manager
        Returns:
        Object form manager
      • getObjectUpdate

        public com.simplicite.webapp.ObjectUpdate getObjectUpdate()
        Get object bulk update manager
        Returns:
        Object update manager
      • getObjectSelect

        public com.simplicite.webapp.ObjectSelect getObjectSelect()
        Get object select manager
        Returns:
        Object select manager
      • getObjectDataMap

        public com.simplicite.webapp.ObjectDataMap getObjectDataMap()
        Get object data mapping manager
        Returns:
        Object data mapping manager
      • getObjectCrosstab

        public com.simplicite.webapp.ObjectCrosstab getObjectCrosstab()
        Get object pivot table manager
        Returns:
        pivot table manager
      • getObjectGraph

        public com.simplicite.webapp.ObjectGraph getObjectGraph()
        Get object chart manager
        Returns:
        Object chart manager
      • getObjectPrint

        public com.simplicite.webapp.ObjectPrint getObjectPrint()
        Het object publication manager
        Returns:
        Object publication manager
      • getObjectDocument

        public com.simplicite.webapp.ObjectDocument getObjectDocument()
        Get object document manager
        Returns:
        Object document manager
      • getObjectView

        public com.simplicite.webapp.ObjectView getObjectView()
        Get object view manager
        Returns:
        Object view manager
      • getObjectIndex

        public com.simplicite.webapp.ObjectIndex getObjectIndex()
        Get object index manager
        Returns:
        Object index manager
      • getObjectTimesheet

        public com.simplicite.webapp.ObjectTimesheet getObjectTimesheet()
        Get object time sheet manager
        Returns:
        Object time sheet manager
      • getObjectPreferences

        public com.simplicite.webapp.ObjectPreference getObjectPreferences()
        Get object preferences manager
        Returns:
        Object preferences manager
      • getObjectMerge

        public com.simplicite.webapp.ObjectMerge getObjectMerge()
        Get object merge manager
        Returns:
        Object merge manager
      • getObjectPlaceMap

        public com.simplicite.webapp.ObjectPlaceMap getObjectPlaceMap()
        Get object place map manager
        Returns:
        Object place map manager
      • getObjectImportExport

        public com.simplicite.webapp.ObjectImportExport getObjectImportExport()
        Get object import/export manager
        Returns:
        Object import/export manager
      • getProcessSearch

        public com.simplicite.webapp.ProcessSearch getProcessSearch()
        Get process search manager
        Returns:
        Process search manager
      • getProcessList

        public com.simplicite.webapp.ProcessList getProcessList()
        Get process list manager
        Returns:
        Process list manager
      • getProcessForm

        public com.simplicite.webapp.ProcessForm getProcessForm()
        Get process form manager
        Returns:
        Process form manager
      • getScriptEditor

        public com.simplicite.webapp.ScriptEditor getScriptEditor()
        Get code editor manager
        Returns:
        Code editor manager
      • getModeler

        public com.simplicite.webapp.Modeler getModeler()
        Get modeler manager
        Returns:
        Modeler manager
      • getNavigator

        public Navigator getNavigator()
        Get navigator manager
        Returns:
        navigator manager
      • T

        public java.lang.String T​(java.lang.String code)
        Get translated text
        Parameters:
        code - Text code
        Returns:
        translated text
      • getText

        public java.lang.String getText​(java.lang.String code)
        Get translated text(alias to T(code))
        Parameters:
        code - Text code
        Returns:
        translated text
      • displayBoolean

        public java.lang.String displayBoolean​(java.lang.String v)
        Display boolean (using yes/no translation)
        Parameters:
        v - Boolean value
        Returns:
        html
      • isLoaded

        public boolean isLoaded​(Grant grant)
        Test if page is loaded.
        Parameters:
        grant - Grant
        Returns:
        True if page is loaded
      • init

        public void init​(Grant g)
        HTML page manager initialization
        Parameters:
        g - Grant (user's rights)
      • init

        public void init​(Grant g,
                         com.simplicite.webapp.ObjectCrosstab objCrosstab,
                         com.simplicite.webapp.ObjectGraph objGraph,
                         com.simplicite.webapp.ObjectPrint objPrint,
                         com.simplicite.webapp.ObjectDocument objDoc)
        HTML page manager initialization
        Parameters:
        g - Grant (user rights)
        objCrosstab - Pivot table manager
        objGraph - Chart manager
        objPrint - Publication manager
        objDoc - Document manager
      • init

        public int init​(Grant g,
                        com.simplicite.webapp.ObjectSearch objSearch,
                        com.simplicite.webapp.ObjectList objList,
                        com.simplicite.webapp.ObjectForm objForm,
                        com.simplicite.webapp.ObjectUpdate objUpdate,
                        com.simplicite.webapp.ObjectSelect objSelect,
                        com.simplicite.webapp.ObjectDataMap objDataMap,
                        com.simplicite.webapp.ObjectView objView,
                        com.simplicite.webapp.ObjectIndex objIndex,
                        com.simplicite.webapp.ObjectImportExport objImpExp,
                        com.simplicite.webapp.ObjectCrosstab objCrosstab,
                        com.simplicite.webapp.ObjectGraph objGraph,
                        com.simplicite.webapp.ObjectPrint objPrint,
                        com.simplicite.webapp.ObjectDocument objDoc,
                        com.simplicite.webapp.ObjectTimesheet objTimesheet,
                        com.simplicite.webapp.ObjectPreference objPref,
                        com.simplicite.webapp.ObjectMerge objMerge,
                        com.simplicite.webapp.ObjectPlaceMap objPlaceMap,
                        com.simplicite.webapp.ProcessSearch pcsSearch,
                        com.simplicite.webapp.ProcessList pcsList,
                        com.simplicite.webapp.ProcessForm pcsForm,
                        com.simplicite.webapp.ScriptEditor scriptEditor,
                        com.simplicite.webapp.Modeler modeler,
                        Navigator nav)
        HTML page manager initialization
        Parameters:
        g - Grant (user rights)
        objSearch - Search manager
        objList - List manager
        objForm - Form manager
        objUpdate - Bulk update manager
        objSelect - Reference select manager
        objDataMap - Data mapping manager
        objView - View manager
        objIndex - Index manager
        objImpExp - Import/export manager
        objCrosstab - Pivot table manager
        objGraph - Chart manager
        objPrint - Publication manager
        objDoc - Document manager
        objTimesheet - Time sheet manager
        objPref - Preferences manager
        objMerge - Merge manager
        objPlaceMap - Place map manager
        pcsSearch - Process search manager
        pcsList - Process list manager
        pcsForm - Process form manager
        scriptEditor - Script editor manager
        modeler - Modeler manager
        nav - Navigation manager
        Returns:
        license status
      • displayPublicFooter

        public java.lang.String displayPublicFooter()
        Displays legacy UI public footer
        Returns:
        HTML
      • displayPublicLeftZone

        public java.lang.String displayPublicLeftZone()
        Displays legacy UI public left zone
        Returns:
        HTML
      • displayPublicRightZone

        public java.lang.String displayPublicRightZone()
        Displays legacy UI public right zone
        Returns:
        HTML
      • displayPublicMainPage

        public java.lang.String displayPublicMainPage​(ServletParameters params)
        Displays legacy UI public main page
        Parameters:
        params - Parameters
        Returns:
        HTML
      • displayHeader

        public java.lang.String displayHeader​(boolean simple)
        Displays legacy UI header
        Parameters:
        simple - Simple header?
        Returns:
        HTML
      • displayShortcuts

        public java.lang.String displayShortcuts()
        Displays legacy UI shortcuts
        Returns:
        HTML
      • displayFooter

        public java.lang.String displayFooter()
        Displays legacy UI footer
        Returns:
        HTML
      • displayMenuZone

        public java.lang.String displayMenuZone​(java.lang.String style,
                                                ServletParameters params)
        Displays legacy UI menu zone
        Parameters:
        style - Menu style
        params - Parameters
        Returns:
        HTML
      • displayExtraZone

        public java.lang.String displayExtraZone()
        Displays legacy UI extra zone
        Returns:
        HTML
      • displayMainPage

        public java.lang.String displayMainPage​(ServletParameters params)
        Displays legacy UI main page
        Parameters:
        params - Parameters
        Returns:
        HTML
      • open

        public java.lang.String open​(java.lang.String title,
                                     ObjectDB obj,
                                     boolean std,
                                     boolean calend,
                                     boolean calc,
                                     boolean color,
                                     boolean htmledit,
                                     boolean undoredo,
                                     boolean treeview,
                                     boolean completion,
                                     boolean charts,
                                     java.lang.String[] extracss,
                                     java.lang.String[] extrajs,
                                     java.lang.String cls)
        Opens legacy UI HTML page
        Parameters:
        title - Page title
        obj - Business object
        std - Include standard styles and javascript
        calend - Include calendars
        calc - Include calculator
        color - Include color picker
        htmledit - Include HTML editor
        undoredo - Include undo-redo features
        treeview - Include tree view
        completion - Include completion
        charts - Include HTML charts (also needs HTML_CHARTS system parameter)
        extracss - Extra stylesheet
        extrajs - Extra javascripts
        cls - CSS class(es) for body
        Returns:
        Beginning of an HTML Page
      • close

        public java.lang.String close()
        Closes legacy UI HTML page
        Returns:
        End of an HTML page
      • link

        public java.lang.String link​(java.lang.String formName,
                                     java.lang.String name,
                                     java.lang.String label,
                                     java.lang.String href,
                                     java.lang.String cls,
                                     int tab)
        Legacy UI anchor link.
        Parameters:
        formName - Form name
        name - Link name
        label - Link label
        href - Reference
        cls - CSS class(es)
        tab - Tab index (0 = no tab index tag)
        Returns:
        html
      • link

        public java.lang.String link​(java.lang.String formName,
                                     java.lang.String name,
                                     java.lang.String label,
                                     java.lang.String targetZone,
                                     java.lang.String url,
                                     boolean confirmDialog,
                                     java.lang.String actionToConfirm,
                                     int tab)
        Legacy UI anchor link with target zone and confirm dialog management.
        Parameters:
        formName - Form name
        name - Link name
        label - Link label
        targetZone - Target zone
        url - URL
        confirmDialog - Show confirm dialog ?
        actionToConfirm - Label of action to confirm
        tab - Tab index (0 = no tab index tag)
        Returns:
        html
      • link

        public java.lang.String link​(java.lang.String formName,
                                     java.lang.String name,
                                     java.lang.String label,
                                     java.lang.String targetZone,
                                     java.lang.String url,
                                     boolean confirmDialog,
                                     java.lang.String actionToConfirm,
                                     java.lang.String extraTags,
                                     java.lang.String cls,
                                     int tab)
        Legacy UI anchor link with target zone and confirm dialog management.
        Parameters:
        formName - Form name
        name - Link name
        label - Link label
        targetZone - Target zone
        url - URL
        confirmDialog - Show confirm dialog ?
        actionToConfirm - Label of action to confirm
        extraTags - Extra HTML tags
        cls - CSS class(es)
        tab - Tab index (0 = no tab index tag)
        Returns:
        html
      • imageLink

        public java.lang.String imageLink​(java.lang.String formName,
                                          java.lang.String name,
                                          java.lang.String label,
                                          java.lang.String src,
                                          java.lang.String targetZone,
                                          java.lang.String url,
                                          boolean confirmDialog,
                                          java.lang.String actionToConfirm,
                                          java.lang.String extraTags,
                                          int tab)
        Legacy UI image link with target zone and confirm dialog management.
        Parameters:
        formName - Form name
        name - Link name
        label - Link label
        src - Image source
        targetZone - Target zone
        url - URL
        confirmDialog - Show confirm dialog ?
        actionToConfirm - Label of action to confirm
        extraTags - Extra HTML tags
        tab - Tab index (0 = no tab index tag)
        Returns:
        html
      • imageLink

        public java.lang.String imageLink​(java.lang.String formName,
                                          java.lang.String name,
                                          java.lang.String label,
                                          java.lang.String src,
                                          java.lang.String targetZone,
                                          java.lang.String url,
                                          boolean confirmDialog,
                                          java.lang.String actionToConfirm,
                                          java.lang.String extraTags,
                                          java.lang.String cls,
                                          int tab)
        Legacy UI image link with target zone and confirm dialog management.
        Parameters:
        formName - Form name
        name - Link name
        label - Link label
        src - Image source
        targetZone - Target zone
        url - URL
        confirmDialog - Show confirm dialog ?
        actionToConfirm - Label of action to confirm
        extraTags - Extra HTML tags
        cls - CSS class(es)
        tab - Tab index (0 = no tab index tag)
        Returns:
        html
      • textLink

        public java.lang.String textLink​(java.lang.String formName,
                                         java.lang.String name,
                                         java.lang.String label,
                                         java.lang.String targetZone,
                                         java.lang.String url,
                                         boolean confirmDialog,
                                         java.lang.String actionToConfirm,
                                         java.lang.String extraTags,
                                         java.lang.String cls,
                                         int tab)
        Legacy UI text link with target zone and confirm dialog management.
        Parameters:
        formName - Form name
        name - Link name
        label - Link label
        targetZone - Target zone
        url - URL
        confirmDialog - Show confirm dialog ?
        actionToConfirm - Label of action to confirm
        extraTags - Extra HTML tags
        cls - CSS class(es)
        tab - Tab index (0 = no tab index tag)
        Returns:
        html
      • booleanInputAsSelectBox

        public java.lang.String booleanInputAsSelectBox​(java.lang.String formName,
                                                        java.lang.String name,
                                                        boolean valueSelected,
                                                        boolean value,
                                                        int tab)
        Legacy UI boolean input (select box style)
        Parameters:
        formName - Form name
        name - Input name
        valueSelected - Is a value selected by default ?
        value - Input value
        tab - Tab index (0 = no tab index tag)
        Returns:
        html
      • booleanInputAsRadioButtons

        public java.lang.String booleanInputAsRadioButtons​(java.lang.String formName,
                                                           java.lang.String name,
                                                           boolean valueSelected,
                                                           boolean value,
                                                           int tab)
        Legacy UI boolean input (radio button style)
        Parameters:
        formName - Form name
        name - Input name
        valueSelected - Is a value selected by default ?
        value - Input value (true/false) ?
        tab - Start tab index (0 = no tab index tag)
        Returns:
        html
      • selectPopupButton

        public java.lang.String selectPopupButton​(Grant g,
                                                  java.lang.String obj,
                                                  java.lang.String formName,
                                                  java.lang.String name,
                                                  java.lang.String params,
                                                  int tab)
        Legacy UI select reference popup button
        Parameters:
        g - Grant
        obj - Object
        formName - Form name
        name - Select button name
        params - URL parameters (e.g. "object=MyObject&inst=the_MyObject")
        tab - Start tab index (0 = no explicit tab index)
        Returns:
        html
      • metaObjectPopupButton

        public java.lang.String metaObjectPopupButton​(Grant g,
                                                      java.lang.String obj,
                                                      java.lang.String formName,
                                                      java.lang.String name,
                                                      java.lang.String params,
                                                      int tab)
        Legacy UI select meta object popup button
        Parameters:
        g - Grant
        obj - Object
        formName - Form name
        name - Select button name
        params - URL parameters (e.g. "object=MyObject&inst=the_MyObject")
        tab - Start tab index (0 = no explicit tab index)
        Returns:
        html
      • datamapPopupButton

        public java.lang.String datamapPopupButton​(Grant g,
                                                   java.lang.String obj,
                                                   java.lang.String formName,
                                                   java.lang.String name,
                                                   java.lang.String params,
                                                   java.lang.String datamaps,
                                                   int tab)
        Legacy UI data mapping popup button
        Parameters:
        g - Grant
        obj - Object
        formName - Form name
        name - Select button name
        params - URL parameters (e.g. "object=MyObject&inst=the_MyObject")
        datamaps - List of mappings (e.g. "object=MyObject&inst=the_MyObject")
        tab - Start tab index (0 = no explicit tab index)
        Returns:
        html
      • info

        public java.lang.String info​(java.lang.String msg)
        Formats information message
        Parameters:
        msg - Message
        Returns:
        information message
      • warning

        public java.lang.String warning​(java.lang.String msg)
        Formats warning message
        Parameters:
        msg - Message
        Returns:
        warning message
      • error

        public java.lang.String error​(java.lang.String msg)
        Formats error message
        Parameters:
        msg - Message
        Returns:
        formatted error
      • fatal

        public java.lang.String fatal​(java.lang.String msg)
        Formats fatal error message
        Parameters:
        msg - Message
        Returns:
        fatal error message
      • getPoweredBy

        public java.lang.String getPoweredBy()
        Get "powered by" block
        Returns:
        HTML
      • isResponsive

        public boolean isResponsive​(javax.servlet.http.HttpServletRequest request,
                                    javax.servlet.http.HttpServletResponse response)
        Check if requested UI is responsive UI
        Parameters:
        request - HTTP request
        response - HTTP response (used to set the mobile cookie)
        Returns:
        True if requested UI is mobile UI
      • isMobile

        @Deprecated
        public boolean isMobile​(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
        Deprecated.
        Use isResponsive