ui.Interface methods

Methods of the ui.Interface class

Table 1. Class methods
Name Description 
ui.Interface.frontCall(
   moduleName STRING,
   functionName STRING,
   [ valueList ],
   [ variableList ] )
 ui.Interface.frontCall performs a function call to the current front-end. 
ui.Interface.filenameToURI(
   path STRING )
  RETURNS STRING
 Converts a file name to an URI to be used as a web component image resource. 
ui.Interface.getChildCount()
  RETURNS INTEGER
 Get the number of children in a parent container. 
ui.Interface.getChildInstances(
   name STRING )
  RETURNS INTEGER
 Get the number of child instances for a given program name. 
ui.Interface.getContainer()
  RETURNS STRING
 Get the parent container of the current program. 
ui.Interface.getDocument()
  RETURNS  om.DomDocument
 Returns the DOM document of the abstract user interface tree. 
ui.Interface.getFrontEndName()
  RETURNS STRING
 Returns the type of the front-end currently in use. 
ui.Interface.getFrontEndVersion()
  RETURNS STRING
 Returns the version of the front-end currently in use. 
ui.Interface.getName()
  RETURNS STRING
 ui.Interface.frontCall performs a function call to the current front-end. 
ui.Interface.getImage()
  RETURNS STRING
 ui.Interface.frontCall performs a function call to the current front-end. 
ui.Interface.getText()
  RETURNS STRING
 Returns the title of the program. 
ui.Interface.getType()
  RETURNS STRING
 Returns the type of the program. 
ui.Interface.getRootNode()
  RETURNS om.DomNode
 Get the root DOM node of the abstract user interface. 
ui.Interface.loadActionDefaults(
   filename STRING )
 Load the default action defaults file. 
ui.Interface.loadStartMenu(
   filename STRING )
 Load the start menu file. 
ui.Interface.loadToolBar(
   filename STRING )
 Load a default toolbar file. 
ui.Interface.loadTopMenu(
   filename STRING )
 Load a default topmenu file. 
ui.Interface.loadStyles(
   filename STRING )
 Load the presentation styles file. 
ui.Interface.refresh()
 Synchronize the user interface with the front-end. 
ui.Interface.setImage(
   image STRING )
 Defines the icon image of the program. 
ui.Interface.setName(
   name STRING )
 Define the name of the current program for the front-end. 
ui.Interface.setText(
   title STRING )
 Defines the title for the program. 
ui.Interface.setType(
   type STRING )
 Defines the type of the program for the front-end. 
ui.Interface.setSize(
   h INTEGER,
   w INTEGER )
 Specify the initial size of the parent container window. 
ui.Interface.setContainer(
   name STRING )
 Define the parent container for the current program.