Package com.ebasetech.xi.api.controls

Interface InfoProperties

All Superinterfaces:

TextStyleProperties

public interface InfoProperties
extends TextStyleProperties

The InfoProperties interface represents properties that apply to field help texts.

Since:

V4.4

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHAlign()	Horizontal alignment of the field help text when it is positioned underneath the field editor (see FieldControl.setHelpPos(int).
ImageStyleProperties	getImageProperties()	Text properties for the help text.
BackgroundStyleProperties	getPopupBackgroundProperties()	Background properties for the popup help text window.
PaddingStyleProperties	getPopupPaddingProperties()	Padding properties for the help text.
TextStyleProperties	getPopupTextProperties()	Image properties for the clickable help image.
InfoPopupProperties	getPopupWindowProperties()	Properties for the popup help text window.
void	setHAlign(java.lang.String hAlign)	Sets the horizontal alignment of the field help text when it is positioned underneath the field editor (see FieldControl.setHelpPos(int).

Methods inherited from interface com.ebasetech.xi.api.controls.TextStyleProperties

getLineHeight, getTextBold, getTextColor, getTextDecoration, getTextFont, getTextItalic, getTextSize, setLineHeight, setTextBold, setTextColor, setTextDecoration, setTextFont, setTextItalic, setTextSize

Method Details

getImageProperties

ImageStyleProperties getImageProperties()

Text properties for the help text.

Further documentation.

Since:

V4.4

getPopupTextProperties

TextStyleProperties getPopupTextProperties()

Image properties for the clickable help image.

Further documentation.

Since:

V4.4

getPopupPaddingProperties

PaddingStyleProperties getPopupPaddingProperties()

Padding properties for the help text.

Further documentation.

Since:

V4.4

getPopupBackgroundProperties

BackgroundStyleProperties getPopupBackgroundProperties()

Background properties for the popup help text window.

Further documentation.

Since:

V4.4

getPopupWindowProperties

InfoPopupProperties getPopupWindowProperties()

Properties for the popup help text window.

Further documentation.

Since:

V4.4

getHAlign

java.lang.String getHAlign()

Horizontal alignment of the field help text when it is positioned underneath the field editor (see FieldControl.setHelpPos(int). See setHAlign(String) for details of supported values when setting this property.

Since:

V4.4

setHAlign

void setHAlign(java.lang.String hAlign)

Sets the horizontal alignment of the field help text when it is positioned underneath the field editor (see FieldControl.setHelpPos(int).

Supported values:

Value	Constant
Center	ControlConstants.HORIZONTAL_ALIGNMENT_CENTER
Left	ControlConstants.HORIZONTAL_ALIGNMENT_LEFT
Right	ControlConstants.HORIZONTAL_ALIGNMENT_RIGHT

Setting a value of null removes any existing value for the property.

Since:

V4.4