IRISLIB database
SMNavigatorPane Class Reference

This class is used internally by InterSystems IRIS. More...

Inheritance diagram for SMNavigatorPane:
Collaboration diagram for SMNavigatorPane:

Public Member Functions

_.Library.Status DrawBODY (_.CSP.Util.PageInstance pInstance)
 Overwritten by subclasses to draw anything this pane needs for the BODY section.
 
_.Library.Status DrawHEAD (_.CSP.Util.PageInstance pInstance)
 Overwritten by subclasses to draw anything this pane needs for the HEAD section.
 
_.Library.String OnGenerateCode ()
 Subclasses override this to generate code during CSP processing.
 
- Public Member Functions inherited from Pane
_.Library.Status DrawCommandForm (_.CSP.Util.PageInstance pInstance)
 Generic method to draw a command form for a pane.
 
_.Library.Status DrawCommands (_.CSP.Util.PageInstance pInstance)
 Generic method to draw commands for a pane;. More...
 
_.Library.String GenerateCode ()
 Called by CSP rules engine to generate code to construct an instance. More...
 
- 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 Adaptor
_.Library.Status XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
 Serialize an XML enabled class as an XML document and write. More...
 
_.Library.Status XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and appends it to a stream. More...
 
_.Library.Status XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
 Serialize an XML enabled class as an XML document and write it to a string. More...
 

Static Public Member Functions

_.Library.Integer GetAllDatabases (_.Library.String Databases)
 Generic method to get databases. More...
 
_.Library.Integer GetAllNamespaces (_.Library.String Namespaces, _.Library.String ShardInfo)
 Generic method to get namespaces from the ACTIVE Configuration file. More...
 
_.Library.Integer GetNamespaces (_.Library.String Namespaces)
 Generic method to get namespaces from the ACTIVE Configuration file. More...
 
_.Library.Integer GetSchemas (_.Library.String Schemas)
 Generic method to get Schemas for the current namespace. More...
 
- Static Public Member Functions inherited from Pane
_.Library.String LocalizeText (_.Library.String pText, _.Library.String pDomain)
 Return the localized version of the string pText. More...
 
_.Library.String QuoteCOS (_.Library.String pText)
 Return a quoted, COS version of a string.
 
- Static Public Member Functions inherited from Adaptor
_.Library.Status XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
 Write the DTD to the current device for this XML enabled class serialized as. More...
 
_.Library.RegisteredObject XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
 Get an instance of an XML enabled class. More...
 
_.Library.Status XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
 Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...
 
_.Library.String XMLSchemaNamespace ()
 Get the namespace to which this class belongs for use in schema generation. More...
 
_.Library.Status XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
 Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...
 

Public Attributes

 ShowDatabases
 If 1, then namespace listbox allows choice of databases as well. More...
 
 ShowMaxRows
 If true, then the max rows textbox is display. More...
 
 ShowNamespaces
 If 1, then namespace listbox displays. More...
 
 ShowSchemas
 If true, then schema listbox is display. More...
 
 bgcolor
 Table background color. More...
 
 border
 Border of table (default is 0) More...
 
 cellpadding
 Cellpadding (default is 0) More...
 
 cellspacing
 Cellspacing (default is 0) More...
 
- Public Attributes inherited from Pane
 Align
 Suggestion for how to align this pane; Actual implementation is up. More...
 
 CommandFormClass
 Name of class used to provide an option CommandForm: a form. More...
 
 CommandFormObject
 Used to hold the object instance for the command form. More...
 
 CommandSubmitPage
 Page (URL) to go to when the command form is submitted. More...
 
 Commands
 A list of commands; these are actions that. More...
 
 FrameStyle
 Optional Style Sheet for a pane; Set to "none" to supress style-sheet for a fram. More...
 
 Name
 Transient: name of the pane/frame this pane is being used for. More...
 
 Styles
 Arbitrary array of styles (name/value pairs). More...
 
 Text
 Test for this pane. More...
 
 URL
 Optional URL to display instead of this pane (for frame-pages) More...
 

Additional Inherited Members

- Static Public Attributes inherited from Pane
 DOMAIN = None
 Default Localization Domain.
 
- 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 Adaptor
 ATTRIBUTEQUALIFIED = None
 ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...
 
 ELEMENTQUALIFIED = None
 ELEMENTQUALIFIED controls the format of exported XML. More...
 
 NAMESPACE = None
 NAMESPACE specifies the XML namespace to be used when projecting the. More...
 
 SUPPRESSTYPEPREFIX = None
 SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...
 
 XMLDEFAULTREFERENCE = None
 XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...
 
 XMLENABLED = None
 If this parameter is true then XML-enabling methods. More...
 
 XMLFORMAT = None
 The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...
 
 XMLIGNOREINVALIDATTRIBUTE = None
 The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNOREINVALIDTAG = None
 The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...
 
 XMLIGNORENULL = None
 XMLIGNORENULL allows the programmer to override the default XML handling. More...
 
 XMLINCLUDEINGROUP = None
 XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...
 
 XMLINHERITANCE = None
 If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...
 
 XMLNAME = None
 This parameter provides the default XMLNAME for the class. More...
 
 XMLNIL = None
 The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...
 
 XMLNILNOOBJECT = None
 The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...
 
 XMLPREFIX = None
 The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...
 
 XMLSEQUENCE = None
 If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...
 
 XMLSUMMARY = None
 The summary fields to be used when an object is referenced are specified. More...
 
 XMLTYPE = None
 This parameter provides the default XMLTYPE for the class. More...
 
 XMLUNSWIZZLE = None
 If the XMLUNSWIZZLE parameter is set to 1, then single object. More...
 
 XMLUSEEMPTYELEMENT = None
 If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...
 

Detailed Description

This class is used internally by InterSystems IRIS.

You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Navigator Pane for System Managment Portal.

Member Function Documentation

◆ GetAllDatabases()

_.Library.Integer GetAllDatabases ( _.Library.String  Databases)
static

Generic method to get databases.

Databases array is returned by reference.
Remote databases are included

◆ GetAllNamespaces()

_.Library.Integer GetAllNamespaces ( _.Library.String  Namespaces,
_.Library.String  ShardInfo 
)
static

Generic method to get namespaces from the ACTIVE Configuration file.


Namespace array is returned by reference.

◆ GetNamespaces()

_.Library.Integer GetNamespaces ( _.Library.String  Namespaces)
static

Generic method to get namespaces from the ACTIVE Configuration file.

Namespace array is returned by reference. Returns array of namespaces the user has Read or Write privileges in.

◆ GetSchemas()

_.Library.Integer GetSchemas ( _.Library.String  Schemas)
static

Generic method to get Schemas for the current namespace.

Namespace array is returned by reference.

Member Data Documentation

◆ ShowDatabases

ShowDatabases

If 1, then namespace listbox allows choice of databases as well.

 

◆ ShowMaxRows

ShowMaxRows

If true, then the max rows textbox is display.

 

◆ ShowNamespaces

ShowNamespaces

If 1, then namespace listbox displays.

If 0, then namespace name displays.  

◆ ShowSchemas

ShowSchemas

If true, then schema listbox is display.

 

◆ bgcolor

bgcolor

Table background color.

 

◆ border

border

Border of table (default is 0)

 

◆ cellpadding

cellpadding

Cellpadding (default is 0)

 

◆ cellspacing

cellspacing

Cellspacing (default is 0)