ui.Interface methods

Methods of the ui.Interface class

Table 1. Class methods
Name Description
ui.Interface.frontCall(
   module STRING,
   function STRING,
   [ parameter-list ],
   [ returning-list ] )
Performs function calls to the current front end.
ui.Interface.getDocument()
  RETURNING result om.DomDocument
Returns the DOM document of the abstract user interface tree.
ui.Interface.getFrontEndName()
  RETURNING result STRING
Returns the type of the front-end currently in use.
ui.Interface.getFrontEndVersion()
  RETURNING result STRING
Returns the version of the front-end currently in use.
ui.Interface.getRootNode()
  RETURNING result om.DomNode
Get the root DOM node of the abstract user interface.
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.loadActionDefaults(
   filename STRING )
Load the default action defaults file.
ui.Interface.loadStyles(
   filename STRING )
Load the presentation styles file.
ui.Interface.setName(
   name STRING )
Define the name of the current program for the front-end.
ui.Interface.getName()
  RETURNING result STRING
Performs function calls to the current front end.
ui.Interface.setText(
   title STRING )
Defines the title for the program.
ui.Interface.getText()
  RETURNING result STRING
Returns the title of the program.
ui.Interface.setImage(
   icon STRING )
Defines the icon image of the program.
ui.Interface.getImage()
  RETURNING result STRING
Performs function calls to the current front end.
ui.Interface.setType(
   type STRING )
Defines the type of the program for the front-end.
ui.Interface.getType()
  RETURNING result STRING
Returns the type of the program.
ui.Interface.setSize(
   height INTEGER,
   width INTEGER )
Specify the initial size of the parent container window.
ui.Interface.setContainer(
   name STRING )
Define the parent container for the current program.
ui.Interface.getContainer()
  RETURNING result STRING
Get the parent container of the curren program.
ui.Interface.getChildCount()
  RETURNING result INTEGER
Get the number of children in a parent container.
ui.Interface.getChildInstances(
   name STRING )
  RETURNING result INTEGER
Get the number of child instances for a given application name.
ui.Interface.refresh()
Synchronize the user interface with the front-end.