Login applet parameters

Note The diagrams of the login applet's parameters may help you to understand the parameters described in this topic.

The login applet has the following parameters:

ParameterTypeDefaultDescription
AsadPortIntegerNo default

The TCP port the login applet uses to communicate with the Tarantella server.

Use the placeholder %%ASADPORT%% to let Tarantella supply the correct value for this parameter. You should only enter a particular value for this parameter (rather than the placeholder) if you're sure you know what you're doing.

This parameter has no default value. Communication with the Tarantella server is only possible if you supply a valid TCP port number (or use %%ASADPORT%%).

HintsBackgroundColorColor definition192,192,192 (Grey)

The background color of the hints area.

HintsFontFamilyFont familyBrowser dependent

The font used to display hints.

HintsFontSizeIntegerBrowser dependent

The point size of the font used to display hints.

HintsFontStyleStyle indicatorplain

The style of font used to display hints.

HintsForegroundColorColor definition0,0,0 (Black)

The color hints appear in.

HintsHeightInteger0

The height of the hints area.

The hints area is used by Tarantella to display messages about the login process for the user.

The hints area is bottom-aligned within the applet area.

The setting 0 means Tarantella doesn't display hints to the user.

LoginButtonDownImageGraphic filenameNo graphicA graphics file to represent the button when it is clicked.
LoginButtonUpImageGraphic filenameNo graphic

A graphics file to represent the button in its unclicked (default) state.

If you don't specify this image, the login applet doesn't provide a login button.

If the login button overlaps MainImage or TitleImage, LoginButtonUpImage obscures these images.

LoginButtonXInteger0

The gap between the login button's left edge and the title area's left side. The value 0 (the default) means the login button's left edge is aligned with the title area's left side.

LoginButtonYInteger0

The gap between the top edge of the applet area and the top of the login button. The value 0 (the default) means the top of the login button is aligned with the title area's top edge.

MainImageGraphic filenameNo graphic

The background image that the login applet displays.

The login applet displays this image horizontally centered and top-aligned within the applet area. If you specify MainImageY, MainImage appears offset from the top of the applet area by this amount.

All other elements (captions and text boxes, for example) are displayed in front of MainImage, except for TitleImage.

MainImageYInteger0

The gap between the background image MainImage and the top of the applet area.

NameCaptionCenterYInteger0

The gap between the top edge of the applet area and the center of the username caption area. The value 0 (the default) means the center of the username caption area is aligned with the applet area's top edge.

The username caption area displays the text specified by NameCaptionText.

NameCaptionFontFamilyFont familyBrowser dependent

The font used to display NameCaptionText.

NameCaptionFontSizeIntegerBrowser dependent

The point size of the font used to display NameCaptionText.

NameCaptionFontStyleStyle indicatorplain

The style of font used to display NameCaptionText.< /td>

NameCaptionForegroundColorColor definition0,0,0 (Black)

The color of NameCaptionText.

NameCaptionHorizontalAlignmentAlignment indicatorleft

How NameCaptionText is aligned within the username caption area.

NameCaptionTextString""

The text displayed in the username caption area, for example, "Username".

NameCaptionWidthInteger0

The width of the username caption area.

The username caption area doesn't clip NameCaptionText -- text is allowed to extend beyond the width of the username caption area. This setting is used to calculate the position of text when used with NameCaptionHorizontalAlignment values of center and right.

A value of 0 means the applet won't display NameCaptionText.

NameCaptionXInteger0

The gap between the username caption area's left edge and the applet area's left side. The value 0 (the default) means the username caption area's left edge is aligned with the applet area's left side.

The username caption area displays the text specified by NameCaptionText.

NameEditBackgroundColorColor definition255,255,255 (White)

The color of the username text box's background.

NameEditCenterYInteger0

The gap between the top edge of the applet area and the center of the username text box. The value 0 (the default) means the center of the username text box is aligned with the applet area's top edge.

NameEditFontFamilyFont familyBrowser dependent

The font used to display text in the username text box.

NameEditFontSizeIntegerBrowser dependent

The point size of the font used to display text in the username text box.

NameEditFontStyleStyle indicatorplain

The style of font used to display text in the username text box.

NameEditForegroundColorColor definition0,0,0 (Black)

The color of text displayed in the username text box.

NameEditTextString""

Any default text to appear in the username text box. By default, the username text box is empty.

NameEditWidthInteger0

The width of the username text box.

NameEditXInteger0

The gap between the username text box's left edge and the applet area's left side. The value 0 (the default) means the username text box's left edge is aligned with the applet area's left side.

PasswordCaptionCenterYInteger0

The gap between the top edge of the applet area and the center of the password caption area. The value 0 (the default) means the center of the password caption area is aligned with the applet area's top edge.

The password caption area displays the text specified by PasswordCaptionText.

PasswordCaptionFontFamilyFont familyBrowser dependent

The font used to display PasswordCaptionText.

PasswordCaptionFontSizeIntegerBrowser dependent

The point size of the font used to display PasswordCaptionText.

PasswordCaptionFontStyleStyle indicatorplain

The style of font used to display PasswordCaptionText.

PasswordCaptionForegroundColorColor definition0,0,0 (Black)

The color of PasswordCaptionText.

PasswordCaptionHorizontalAlignmentAlignment indicatorleft

How PasswordCaptionText is aligned within the title area.

PasswordCaptionTextString""

The text displayed in the password caption area, for example, "Password".

PasswordCaptionWidthInteger0

The width of the password caption area.

The password caption area doesn't clip PasswordCaptionText -- text is allowed to extend beyond the width of the password caption area. This setting is used to calculate the position of text when used with PasswordCaptionHorizontalAlignment values of center and right.

PasswordCaptionXInteger0

The gap between the password caption area's left edge and the applet area's left side. The value 0 (the default) means the password caption area's left edge is aligned with the applet area's left side.

The password caption area displays the text specified by PasswordCaptionText.

PasswordEditBackgroundColorColor definition255,255,255 (White)

The color of the password text box's background.

PasswordEditCenterYInteger0

The gap between the top edge of the applet area and the center of the password text box. The value 0 (the default) means the center of the password text box is aligned with the applet area's top edge.

PasswordEditFontFamilyFont familyBrowser dependent

The font used to display text in the password text box.

PasswordEditFontSizeIntegerBrowser dependent

The point size of the font used to display text in the password text box.

PasswordEditFontStyleStyle indicatorplain

The style of font used to display text in the password text box.

PasswordEditForegroundColorColor definition0,0,0 (Black)

The color of any text displayed in the password text box.

PasswordEditTextString""

Any default password text to appear in the password text box. The actual text will be hidden by asterisks. By default, the password text box is empty.

PasswordEditWidthInteger0

The width of the password text box.

PasswordEditXInteger0

The gap between the password text box's left edge and the applet area's left side. The value 0 (the default) means the password text box's left edge is aligned with the applet area's left side.

TargetFrameString"_self"

The name of the frame used to display the webtop tray applet.

Use the placeholder %%TARGETFRAME%% to let Tarantella supply the correct value for this parameter.

TitleCenterYInteger0

The gap between the top edge of the applet area and the center of the title area. The value 0 (the default) means the center of the title area is aligned with the applet area's top edge.

Note that the title area only displays the text specified by TitleText. This setting doesn't affect how the applet displays TitleImage.

TitleFontFamilyFont familyBrowser dependent

The font used to display TitleText.

TitleFontSizeIntegerBrowser dependent

The point size of the font used to display TitleText.

TitleFontStyleStyle indicatorplain

The style of font used to display TitleText.

TitleForegroundColorColor definition0,0,0 (Black)

The color of TitleText.

TitleHorizontalAlignmentAlignment indicatorleft

How TitleText is aligned within the title area.

TitleImageGraphic filenameNo graphic

A graphic file to be used either as a title or the background to TitleText.

The login applet displays this image horizontally centered and top-aligned within the applet area.

If you specify MainImage, use MainImageY to offset MainImage. If you don't, MainImage will obscure TitleImage.

TitleTextString""

The text displayed in the title area, for example, "Welcome to Tarantella".

TitleWidthInteger0

The width of the title area.

The title area doesn't clip TitleText -- text is allowed to extend beyond the width of the title area. This setting is used to calculate the position of text when used with TitleHorizontalAlignment values of center and right.

A value of 0 means the applet won't display TitleText.

Note that the title area only displays the text specified by TitleText. This setting doesn't affect how the applet displays TitleImage.

TitleXInteger0

The gap between the title area's left edge and the applet area's left side. The value 0 (the default) means the title area's left edge is aligned with the applet area's left side.

Note that the title area only displays the text specified by TitleText. This setting doesn't affect how the applet displays TitleImage.

Diagrams of the login applet's parameters

Title, main image and hints parameters

Username and password caption parameters

Username and password edit parameters

Login button parameters

Related topics
  • Login applet
  • Applet parameter data types