pp108 : container

container


Acts as a framework or container for the applications started using theselect()method of the application component.

Syntax


The container object is automatically created by the framework when a new application has to be started. It offers a collection of methods that can be operated from it, which helps handling the container of the application as such. The container can be accessed through the application by the following format:

application.container.<methodName>


The container gives some additional GUI around an application, represented by a guiRepresentation property which can be accessed as follows:

application.container.guiRepresentation.<methodName>


The containers property in the system component gives a list of all the containers created.

system.containers.<containerName>


Following are the properties and methods defined for the container object:

Property

Description

applicationId

READ-ONLY. String that denotes the ID of the application that is opened.

applicationState

READ-ONLY. String that denotes the state of the application. Can be any one of the following:

  • initializing- Container is initializing.
  • loading- Container is loading.
  • loaded- Container is loaded completely.
  • not loaded- Container is not loaded.

applicationWindow

READ-ONLY. Object that denotes the window object of the container which displays the application.

caption

READ-ONLY. String that denotes the caption of the application displayed.

description

READ-ONLY. String that denotes the description of the application displayed.

guiRepresentation

Set of APIs exposed for the Application Developer to manipulate the content in the container.

icon

String that contains the url of the icon of the Application opened.

organization

String that denotes the current organization from which the application is displayed.

url

String that denotes the url of the page displayed in the container.

showInTaskbar

Boolean that denotes whether the container is displayed in the taskbar or not. This property depends on the attribute "taskbar" that can be set in the<Application>node of the Application Definition.

  • true- Application will be displayed in the taskbar.
  • false- Application will not be displayed in the taskbar.

title

READ-ONLY. String that denotes the title of the application. This is a combination of the caption and description (caption-description) if both are different, and just the caption if both are same.

visible

READ-ONLY. Boolean that denotes whether the application is visible or not. This property depends on the attribute "visible" that can be set in the <Application> node of the Application Definition.

  • true- Application is visible.
  • false- Application is not visible.

undocked

READ-ONLY. Boolean which specifies whether the application is docked or undocked.

  • true- Indicates that the application is undocked.
  • false- Indicates that the application is docked.


Method

Description

blink

Keeps the container blink after the window is created.

blur

Causes the container object to lose focus.

close

Closes the container. If the application being closed is the last one in the popped-up window, that window also gets closed.
Note: The container close behavior is set to 'soft close'. This means all the events (including the nested ones) and the code that are in the execution block are executed first, and then the container is closed.

dock

Positions the container object in a docked mode in the window. In docked mode, the application is attached to a docking area along the four borders of the main window ("main" Frame which is the default).

focus

Causes the container object to receive focus.

getCaption

Gets the current caption of the container defined in the Application Definition.

getDescription

Gets the current description of the container defined in the Application Definition.

getIcon

Gets the icon specified for the Application which will be displayed in the toolbar. The icon can be set in the Application Definition through the <icon> tag.

getState

Gets the current state of the application inside the container. The state of the application can be one of the following:initializing- Application is getting initialized.loaded- Application is loaded completely.

getTitle

Gets the current title of the container. The title is a combination of<caption>and<description>if the caption and description are different or just<caption>if they are the same.

hide

Hides the container if it is visible.

hideTitle

Hides the titlebar of the container if it is visible.

maximize

Maximizes the size of the container.

minimize

Minimizes the size of the container.

setState(state)

Sets the state of the container object. Can be any one of the following:

  • initializing- Container is initializing.
  • loaded- Container is loaded completed.
  • not loaded- Container is not loaded.

setTitle(caption, description)

Sets the title of the container. This title will be a combination of caption and description (caption-description).

show

Makes the container visible if it is hidden.

showTitle

Makes the "Title Bar" of the application visible if it is not shown.

undock

Undocks the container object to a floating mode. In floating mode, the application can appear anywhere on the screen and should a title bar for identification. A floating application is always on top of all other applications.