TITLEBAR

The title bar is typically placed at the top of a page. The text in the title bar can either be set statically inside the layout definition, or it can be dynamically resolved by a property of the corresponding adapter.

The title bar can have a close icon (cross at the top right) and an online help icon. The close icon always calls the method endProcess of your adapter. This method is provided by the derived adapter class. The default implementation of the endProcess() method in the adapter class forces the session management to release the adapter for garbage collection.

You can overwrite the method in your adapter - but do not forget to call the superclass's method as well.


Properties

Basic
name

Text that is displayed inside the control. Please do not specify the name when using the multi language management - but specify a "textid" instead.

Sometimes obligatory  
textid

Multi language dependent text that is displayed inside the control. The "textid" is translated into a corresponding string at runtime.

Do not specify a "name" inside the control if specifying a "textid".

Sometimes obligatory  
withclose

In the right top corner of the titlebar there is by default a close-icon. Define "false" in this property in order to hide this icon.

The close-icon calls the method "endProcess" of your adapter. "endProcess" is implemented in the class "com.softwareag.cis.server.Model" and by default ends the subsession the adapter is running in. - Override this implementation if this default implementation does not fit to your needs.

Optional

true

false

align

Horizontal alignment of the text that is shown.

Optional

left

center

right

image

URL of image that is displayed inside the control. Any image type (.gif, .jpg, ...) that your browser does understand is valid.

Use the following options to specify the URL:

(A) Define the URL relative to your page. Your page is generated directly into your project's folder. Specifiying "images/xyz.gif" will point into a directory parallel to your page. Specifying "../HTMLBasedGUI/images/new.gif" will point to an image of a neighbour project.

(B) Define a complete URL, like "http://www.softwareag.com/images/logo.gif".

Optional  
helpid

Id that is passed to the online help management.

If this "helpid" is specified then a help-icon will be displayed in the right top corner. If clicking on the icon then the corresponding help will show up.

Optional  
titlestyle

CSS style definition that is directly passed into this control.

With the style you can individually influence the rendering of the control. You can specify any style sheet expressions. Examples are:

border: 1px solid #FF0000

background-color: #808080

You can combine expressions by appending and separating them with a semicolon.

Sometimes it is useful to have a look into the generated HTML code in order to know where direct style definitions are applied. Press right mouse-button in your browser and select the "View source" or "View frame's source" function.

Optional

background-color: #FF0000

color: #0000FF

font-weight: bold

pixelheight

Height of the control in pixels.

Optional

1

2

3

int-value

straighttext

If the text of the control contains HTML tags then these are by default interpreted by the browser. Specifiying STRAIGHTTEXT as "true" means that the browser will directly render the characters without HTML interpretation.

Example: if you want to output the source of an HTML text then STRAIGHTTEXT should be set to "true".

Optional

true

false

closetitle

The text that is entered here appears as tooltip on the close-icon on the right top border of the titlebar.

Optional  
closetitletextid

Multi language dependent text that displays the tooltip on the close-icon. Do not specify a CLOSETITLE if you are specifying a CLOSETITLEID.

Optional  
comment

Comment without any effect on rendering and behaviour. The comment is shown in the layout editor's tree view.

Optional  
Binding
valueprop

Property of the server side adapter from which the titlebar text is dynamically derived.

In situations in which the titlebar should contain some context dependent information you specify an adapter property to provide the text for the control. Do not use "name" or "textid" when using this "valueprop" property.

Optional  
visibleprop

Name of an adapter property that provides the information if this control is displayed or not. As consequence you can control the visibility of the control dynamically.

The server side property needs to be of type "boolean".

Optional  
imageprop

Name of adapter property that provides as value the URL of the image that is shown inside the control.

The URL must either be an absolute URL or a relative URL.

Optional  
withcloseprop

Name of adapter property that indicates if the close icon of the titlebar is visible.

The server side property needs to be of type "boolean".

Optional