|
IRISLIB database
|
|
|
IRISLIB database
|
|
Base Zen application class for the DeepSee UserPortal. More...
Static Public Member Functions | |
| _.Library.Status | GetQuickLinks (pLinks) |
| Provide any quick links for pages. | |
 Static Public Member Functions inherited from application | |
| _.Library.Status | OnPage () |
| Default OnPage handler– only called if no HOMEPAGE. More... | |
| _.Library.Boolean | OnPreHTTP () |
| Event handler for PreHTTP event: this is invoked before. More... | |
| Static Public Member Functions inherited from Page | |
| _.Library.Status | ConvertParameter (_.Library.String url, _.Library.String name, _.Library.String value) |
| You pass this the <parameter>url</parameter> of the page you are going to and a. More... | |
| _.Library.Binary | Decrypt (_.Library.String data) |
| Decrypts the input string using the session.Key value that is unique to. More... | |
| _.Library.String | Encrypt (_.Library.Binary data) |
| Encrypts the input string using the session.Key value that is unique to this. More... | |
| _.Library.String | EscapeHTML (in) |
| This method converts input HTML text into Escaped HTML text. | |
| _.Library.String | EscapeURL (_.Library.String in, _.Library.String charset) |
| This method converts the in input URL string into Escaped URL string. More... | |
| _.Library.String | HyperEventCall (_.Library.String methodName, _.Library.String args, _.Library.Integer type, _.Library.Boolean mobile) |
| This method returns the string that needs to be written to the current. More... | |
| _.Library.String | HyperEventHead (_.Library.Boolean iframeOnly, _.Library.Boolean strict, _.Library.Boolean optionalBroker) |
| This method returns the string that needs to be written to the current. More... | |
| Include (_.Library.String url) | |
| Include another csp page or file in the output at this point. More... | |
| _.Library.String | InsertHiddenField (_.Library.String url, _.Library.String name, _.Library.String value, _.Library.String extra) |
| Inserts a '<input type="hidden" name="Name" value="Value">' tag into the current document. More... | |
| _.Library.String | InsertHiddenFields (_.Library.String url, _.Library.String query) |
| Return the string containing the hidden form tags. More... | |
| _.Library.Boolean | IsPrivate () |
| Returns 1 if this page is in fact a private page (see <parameter>PRIVATE</parameter>). | |
| _.Library.String | Link (_.Library.String link, _.Library.String query, _.Library.Boolean addQ) |
| Tranforms the link specified by link into a URL and returns it as a string. More... | |
| _.Library.Status | OnHTTPHeader (_.Library.Boolean OutputBody) |
| Event handler for PAGE event: this is invoked in order to More... | |
| OnPageError (_.Library.Status sc) | |
| Event handler for any error that occurs on the page. More... | |
| OnPostHTTP () | |
| Event handler for POSTPAGE event: this is invoked after the data. More... | |
| _.Library.Status | OnPostHyperEvent (_.Library.String class, _.Library.String method) |
| Event handler which is invoked after a hyperevent method is called on this page. | |
| _.Library.Status | OnPreHyperEvent (_.Library.String class, _.Library.String method) |
| Event handler which is invoked before a hyperevent method is called on this page. More... | |
| _.Library.Status | Page (_.Library.Boolean skipheader) |
| Process a request to serve a CSPPage. More... | |
| _.Library.String | QuoteJS (in) |
| This method converts input string into quoted JavaScript literal. | |
| _.Library.String | RewriteURL (_.Library.String url) |
| This method will rewrite a URL to use #url()# if needed. | |
| ShowError (_.Library.Status sc) | |
| Display a <class>Status</class> error code to the CSP Page. | |
| StartTimer (_.Library.String name) | |
| Used to get performance information on your CSP pages. More... | |
| StopTimer (_.Library.String name) | |
| Used to time performance information on your CSP pages. More... | |
| ThrowError (_.Library.Status sc) | |
| Passed a <class>Status</class> code this goes to the error page passing this status code. | |
| _.Library.String | UnescapeHTML (in) |
| This method converts Escaped HTML text into normal HTML text. | |
| _.Library.String | UnescapeURL (_.Library.String in, _.Library.String charset) |
| This method converts the in Escaped URL string back to its original form. More... | |
| Static Public Member Functions inherited from Base | |
| _.Library.String | AfterUserAction (_.ZEN.proxyObject pInputProxy, _.ZEN.proxyObject pOutputProxy, _.ZEN.proxyObject pUserData) |
| Server-side wrapper around the AfterUserAction callback. | |
| AppendSourceControlOutput (_.Library.String pOutput) | |
| Add output to the session data on the server. | |
| _.Library.Integer | ClearSourceControlOutput () |
| Clear the output for the session. | |
| CreateProject (_.ZEN.proxyObject pInputProxy, _.ZEN.proxyObject pOutputProxy) | |
| Create a new Studio project on the server. | |
| _.Library.String | DocumentLoad (_.ZEN.proxyObject pInputProxy, _.ZEN.proxyObject pOutputProxy) |
| Implement the correct callbacks around loading a document. | |
| _.Library.String | DocumentSave (_.ZEN.proxyObject pInputProxy, _.ZEN.proxyObject pOutputProxy) |
| Implement the correct callbacks around saving a document. | |
| _.Library.Status | GetSourceControlCommands (_.Library.Boolean pDisplay, pCommands, _.Library.Boolean pNeedProject, _.Library.String pServerOutput) |
| Determine which source control commands should be drawn for the current context. | |
| _.Library.String | GetTimestamp (_.Library.String classname) |
| Get the timestamp for the current document. | |
| _.Library.Boolean | HaveSourceControlOutput () |
| Indicate whether there is Source Control output for the session. | |
| _.Library.Status | LoadProject (_.Studio.SourceControl.Base pSourceControl, _.Library.String pProject, _.Library.Boolean pRedirect) |
| Load the named project in pProject using the source control object. More... | |
| _.Library.String | UserAction (_.ZEN.proxyObject pInputProxy, _.ZEN.proxyObject pOutputProxy) |
| Server-side wrapper around the UserAction callback. | |
| Static Public Member Functions inherited from Util | |
| _.Library.Status | CreateSourceControl (_.Studio.SourceControl.Base pSourceControl, _.Library.Boolean pCreated, _.Library.String pUsername, _.ZEN.proxyObject pUserData) |
| Create an instance of a Source Control object. | |
| _.Library.String | GetCurrentProject (_.Library.Boolean pLoaded) |
| Helper method to retrieve the current project for the CSP session,. More... | |
| GetFullProjectName (_.Library.String pProjectName) | |
| Return a project's full name, including a ".PRJ" extension. | |
| _.Library.String | GetSourceControlClass () |
| Return the source control class which is to be used in the current namespace. More... | |
| _.Library.Boolean | IsEnabled (_.Library.String pNamespace) |
| Determine whether source control is enabled for the Management. More... | |
| _.Library.Boolean | IsProjectRequired () |
| Helper method to indicate whether the source control hooks in the current. More... | |
| SetCurrentProject (_.Library.String pProjectName, _.Library.Boolean pLoaded) | |
| Helper method to save the name of the current project and whether its. More... | |
| _.Library.Status | SetProjectRequired (_.Library.Boolean pNewValue, _.Library.Boolean pOldValue) |
| Enable or disable the flag indicating whether the source control class. More... | |
Static Public Attributes | |
| APPLICATIONNAME = None | |
| This is the name of this application. | |
| COMPANYNAME = None | |
| This is the default company name displayed within this application. | |
| HOMEPAGE = None | |
| This is the URL of the main starting page of this application. | |
| Static Public Attributes inherited from application | |
| APPLICATIONNAME = None | |
| Optional name of this application. More... | |
| CSS3INCLUDES = None | |
| Comma-separated list of additional CSS3 include files that should be. More... | |
| CSSINCLUDES = None | |
| Comma-separated list of additional CSS include files that should be. More... | |
| HOMEPAGE = None | |
| This is the URL of the main starting page of this application. | |
| JSINCLUDES = None | |
| Comma-separated list of additional JS include files that should be. More... | |
| USERPACKAGES = None | |
| Comma-separated list of User class packages whose HTML class. More... | |
| USERSVGPACKAGES = None | |
| Comma-separated list of User class packages whose SVG class. More... | |
| Static Public Attributes inherited from RegisteredObject | |
| CAPTION = None | |
| Optional name used by the Form Wizard for a class when generating forms. More... | |
| JAVATYPE = None | |
| The Java type to be used when exported. | |
| PROPERTYVALIDATION = None | |
| This parameter controls the default validation behavior for the object. More... | |
| Static Public Attributes inherited from Page | |
| CHARSET = None | |
| The <CLASS>CSP.Page</CLASS> object serves as an event handler for CSP requests. More... | |
| CONTENTTYPE = None | |
| Specifies the default content type for the page. More... | |
| CONVERTINPUTSTREAM = None | |
| Specifies if input request.Content or request.MimeData values are converted from their. More... | |
| CSPFILE = None | |
| If this page was compiled from a .csp file, then this parameter contains the. More... | |
| CSPSTRICT = None | |
| The CSPSTRICT parameter is set to 1, if the DOCTYPE indicates that this. More... | |
| CSPURL = None | |
| This parameter is used to make sure that if multiple. More... | |
| CSPXHTML = None | |
| The CSPXHTML parameter is set to 1, if the DOCTYPE indicates that this. More... | |
| DOMAIN = None | |
| The default domain for csp:text, span and div tags. More... | |
| ENCODED = None | |
| Controls how the query parameters for this page are passed, it can. More... | |
| ERRORPAGE = None | |
| Specify a custom error page to call if there are any problems with generating this page. More... | |
| EXPIRES = None | |
| Specified the default value for the response.Expires. More... | |
| NOCHARSETCONVERT = None | |
| Specifies if we wish to turn off charset conversion for this page. More... | |
| PAGETIMING = None | |
| If this parameter is true then we automatically record timing statistics of how long it takes to. More... | |
| PRIVATE = None | |
| Controls the access to the page, it can be set to one of the following: More... | |
| SECURITYRESOURCE = None | |
| This is a comma-delimited list of system Resources and associated. More... | |
| TIMINGSLOTS = None | |
| Used by the timing to decide how many slots a day should be divided up into. More... | |
| UseSession = None | |
| This parameter controls the CSP session support. More... | |
| Static Public Attributes inherited from Base | |
| EDITRESOURCE = None | |
| Resource for subclasses to indicate whether further resources are needed to perform actions on pages. | |
| MANAGERDIALOG = None | |
| Page to use for managing popups requested by the source control framework. | |
| OUTPUTDIALOG = None | |
| Page to use for displaying output from the server. | |
Private Member Functions | |
| DrawSmallMenu (_.Library.String pMenu) | |
| Draw small menu at the top of the title area. | |
| _.Library.Status | DrawTitleHTML (_.Library.String pTitle, pSmallMenu) |
| Draw the HTML contents of the title area for portal pages. | |
| GetServerInfo (pInfo) | |
| Get information about this server, return it via the array pInfo | |
| _.Library.String | OnGetCompanyName () |
| Get the company name for the page. | |
Additional Inherited Members | |
| Public Member Functions inherited from RegisteredObject | |
| _.Library.Status | OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount) |
| This callback method is invoked when the current object is added to the SaveSet,. More... | |
| _.Library.Status | OnClose () |
| This callback method is invoked by the <METHOD>Close</METHOD> method to. More... | |
| _.Library.Status | OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned) |
| This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More... | |
| _.Library.Status | OnNew () |
| This callback method is invoked by the <METHOD>New</METHOD> method to. More... | |
| _.Library.Status | OnValidateObject () |
| This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More... | |
| Public Member Functions inherited from Base | |
| _.Library.String | GetInternalName () |
| Return the internal name of the current document, including the three letter. More... | |
| _.Library.String | UpdateSCMenus (_.Library.Boolean showMenu) |
| Update the _sourceControlMenu Javascript object representing the contents of the source control menus. | |
| appendServerOutput (data, first) | |
| Render the server output from source control commands on the client. | |
| canUserModify (noAlert) | |
| Helper method to indicate whether the user is allowed to make changes to the. More... | |
| checkTextControls () | |
| Helper method for event sequencing: the onmousedown event for the menu buttons and shapes in the SVG diagram. More... | |
| chooseSCMenu (menuName, commandName, saveFlags) | |
| Handle a source control menu selection. | |
| chooseSCProject (projectName, isNew) | |
| The user has selected on of the projects listed in the dropdown. | |
| clearSCOutput () | |
| Clear the source control output on the server and update the content star. | |
| createSCMenuItem (parentItem, caption, onselect) | |
| Helper method to create an item in the source control menu. | |
| createSCProject (projectName) | |
| Create a new project on the server. | |
| createSCSubMenu (parentItem, caption) | |
| Helper method to create a submenu in the source control menu. | |
| getClientModel () | |
| Get the jsonProvider object on the client. More... | |
| getCurrentExtension () | |
| Return the extension used by Studio for the class/object. More... | |
| getCurrentName () | |
| Return the current name of the class/object being modified. More... | |
| _.Library.String | getPageTitle () |
| Get the title string to add to the locator row. More... | |
| getReadOnlyReason () | |
| Callback to get the text of the reason for the current document being loaded as readonly. | |
| getSaveAction (force) | |
| Return the string used as the command when sending JSON content to the server. More... | |
| initializeSourceControl () | |
| Function to initialize the source control hooks for a page. More... | |
| initializeTextMonitor () | |
| Initialize the text monitor for the page. | |
| invokeAfterUserAction (input, userContext) | |
| Client-side coordinator of calls to the AfterUserAction callback in. More... | |
| invokeSourceControl (action, isFramework) | |
| Client-side coordinator of calls to the UserAction callback in. More... | |
| loadDocument () | |
| Method to load document from the client and invoke the correct source control hooks. | |
| onDocumentLoad (when, documentName) | |
| Callback invoked when a document is being loaded. | |
| onDocumentLoadComplete () | |
| Callback method invoked after we have successfully loaded the current document. | |
| onDocumentSave (when, documentName) | |
| Callback invoked when a document is being saved. | |
| onDocumentSaveComplete (contentModified) | |
| Callback method invoked after we successfully save the current document. | |
| onloadHandler () | |
| Add check to ensure that we correctly load documents on the client when source control hooks are in use. | |
| reloadDocument () | |
| Reload the current document. More... | |
| saveDocument (force) | |
| Save the current document using the correct source control hooks. | |
| setReadOnly (readOnly) | |
| Set <property>readOnly</property> to the value of readOnly. More... | |
| setSCProject (newProject) | |
| Notify the server that a specific project has been chosen. | |
| showSCMenu () | |
| Display the source control menu based on the contents of the _sourceControlMenu data. More... | |
| showSCOutput () | |
| Open a popup to display the current source control output. | |
| textControlKeyDown (zenControl) | |
| Key handler to record the value of text fields before the keyboard event is processed. More... | |
| textControlKeyUp (event, zenControl) | |
| Key handler to work out whether user keys entered in controls have. More... | |
| updateDocumentState (alertOnReadOnly) | |
| Helper method to ensure that the <property>readOnly</property> and. More... | |
| updateSCIndicator (haveOutput) | |
| Toggle the display of the star which indicates whether new. More... | |
| Public Attributes inherited from Base | |
| canEdit | |
| Flag to indicate whether the user is permitted to make any changes on a given page. More... | |
| currentNamespace | |
| The current namespace. More... | |
| currentProject | |
| The name of the currently active/selected project. More... | |
| currentUser | |
| The current user's username. More... | |
| hasSCOutput | |
| Flag to indicate whether source control output is present in the current session. More... | |
| msgNotPermitted | |
| Message to inform the user they may not perform a given action. More... | |
| needProject | |
| Flag to indicate whether a project is needed for the current source control hooks. More... | |
| readOnly | |
| If true, user cannot modify the current document. More... | |
| readOnlyReason | |
| Indicator for why a document was marked as readOnly. More... | |
| renamed | |
| Flag to indicate whether the document has been renamed via "Save As". More... | |
| sourceControlEnabled | |
| Flag to indicate whether source control hooks are enabled for the current namespace. More... | |
| sourceControlManagerDialog | |
| Name of the manager page to use for managing popups requested by the source control class. More... | |
| sourceControlNewlineFormat | |
| Flag to control what newline format should be used for reporting data from the server. More... | |
| sourceControlOutputDialog | |
| Name of the output dialog to use. More... | |
| sourceControlVisible | |
| Flag to indicate whether the source control output is currently visible. More... | |
Base Zen application class for the DeepSee UserPortal.
This is used by the HomePage, and Dashboard viewer pages.
1.9.1