Package com.ebasetech.xi.api.controls

Interface FormHeaderProperties

All Superinterfaces:

BackgroundStyleProperties, PaddingStyleProperties, TextStyleProperties

public interface FormHeaderProperties
extends BackgroundStyleProperties, TextStyleProperties, PaddingStyleProperties

Properties for the optional form header text.

Since:

V4.4

Method Summary

Modifier and Type	Method	Description
java.lang.String	getHAlign()	Horizontal alignment for the form header text.
java.lang.String	getPageContentsGap()	The gap between any form header text and the rest of the page contents.
void	setHAlign(java.lang.String hAlign)	Sets the horizontal alignment for the form header text.
void	setPageContentsGap(java.lang.String pageContentsGap)	Sets the gap between any form header text and the rest of the page contents.

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

getBackgroundColor, getBackgroundImage, getBackgroundImagePosition, getBackgroundImageRepeat, setBackgroundColor, setBackgroundImage, setBackgroundImagePosition, setBackgroundImageRepeat

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

getAllPadding, getBottomPadding, getLeftPadding, getRightPadding, getTopPadding, setAllPadding, setBottomPadding, setLeftPadding, setRightPadding, setTopPadding

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

getHAlign

java.lang.String getHAlign()

Horizontal alignment for the form header text. 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 for the form header text.

Supported values:

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

Since:

V4.4

getPageContentsGap

java.lang.String getPageContentsGap()

The gap between any form header text and the rest of the page contents. Ignored if no form header text is configured.

Further documentation.

Since:

V4.4

See Also:

setPageContentsGap(String)

setPageContentsGap

void setPageContentsGap(java.lang.String pageContentsGap)

Sets the gap between any form header text and the rest of the page contents. Ignored if no form header text is configured. Any valid value for the CSS margin-bottom property can be used.

Further documentation.

Examples:

 controls.PAGE1.formHeaderProperties.pageContentsGap = "10px";
 

Since:

V4.4