com.ebasetech.xi.api.controls
Interface PageControl

All Superinterfaces:

BackgroundStyleProperties, BorderStyleProperties, ContainerControl, Control, Element, EventOwner, LayoutControl, MessageContainer, MessageProperties, java.io.Serializable, WebFormEventOwner

public interface PageControl
extends LayoutControl, BackgroundStyleProperties, BorderStyleProperties

Page Control is a special control that must exist as the root control of each page. A single Page Control is always added to each new page as it is created and this control cannot be deleted. Additional Page Controls cannot be added. A Page Control acts as the root container for each page.

Further documentation.

Method Summary

java.lang.String	getAlignment() Specifies the horizontal alignment for the entire page within the browser window.
java.lang.String	getContentClass() Returns the list of CSS classes applied to the page content.
BackgroundStyleProperties	getContentsBackgroundProperties() Background properties for the page contents.
BorderStyleProperties	getContentsBorderProperties() Border properties for the page contents.
java.lang.String	getContentsHeight() The height of the page contents area.
TextStyleProperties	getContentsTextProperties() The default text properties for the page.
java.lang.String	getContentStyle() Returns the inline CSS style applied to the page content.
FormHeaderProperties	getFormHeaderProperties() Form header properties.
java.lang.String	getFormPanelWidth() Form panel width.
java.lang.String	getJSPBottom() The URL of the bottom JSP relative to the document root of the Ebase web application.
java.lang.String	getJSPLeft() The URL of the left JSP relative to the document root of the Ebase web application.
java.lang.String	getJSPLeftWidth() Left JSP width.
java.lang.String	getJSPRight() The URL of the right JSP relative to the document root of the Ebase web application.
java.lang.String	getJSPRightWidth() Right JSP width.
java.lang.String	getJSPTop() The URL of the top JSP relative to the document root of the Ebase web application.
java.lang.String	getPdfBorder() Returns the inline CSS style applied to any configured PDF borders when a page is included in a PDF.
java.lang.String	getPdfFooterMarginTextClass() Returns the list of CSS classes applied to the PDF footer text when a page is included in a PDF.
java.lang.String	getPdfFooterMarginTextStyle() Returns the inline CSS style applied to the PDF footer text when a page is included in a PDF.
Text	getPdfFooterText() Returns the Text object for the PDF footer text when a page is included in a PDF.
java.lang.String	getPdfHeaderMarginTextClass() Returns the list of CSS classes applied to the PDF header text when a page is included in a PDF.
java.lang.String	getPdfHeaderMarginTextStyle() Returns the inline CSS style applied to the PDF header text when a page is included in a PDF.
Text	getPdfHeaderText() Returns the Text object for the PDF header text when a page is included in a PDF.
java.lang.String	getPdfMargin() Returns the inline CSS style applied to any configured PDF margins when a page is included in a PDF.
java.lang.String	getPdfOrientation() Returns the PDF orientation, portrait or landscape, when a page is included in a PDF.
java.lang.String	getPdfPageSize() Returns the PDF page size when a page is included in a PDF.
PDFPageStyleProperties	getPDFPageStyleProperties() Styling properties that apply only when the page is printed to a PDF.
java.lang.String	getWidth() Page width.
void	setAlignment(java.lang.String alignment) Sets the horizontal alignment for the entire page within the browser window.
void	setContentClass(java.lang.String contentClass) Sets one or more CSS classes to be applied to the page content.
void	setContentsHeight(java.lang.String contentsHeight) Sets the height of the page contents area.
void	setContentStyle(java.lang.String contentStyle) Sets the inline CSS style to be applied to the page content.
void	setFormPanelWidth(java.lang.String formPanelWidth) Sets the form panel width.
void	setJSPBottom(java.lang.String jSPBottom) Sets the URL of the bottom JSP relative to the document root of the Ebase web application.
void	setJSPLeft(java.lang.String jSPLeft) Sets the URL of the left JSP relative to the document root of the Ebase web application.
void	setJSPLeftWidth(java.lang.String jSPLeftWidth) Sets the left JSP width.
void	setJSPRight(java.lang.String jSPRight) Sets the URL of the right JSP relative to the document root of the Ebase web application.
void	setJSPRightWidth(java.lang.String jSPRightWidth) Sets the right JSP width.
void	setJSPTop(java.lang.String jSPTop) Sets the URL of the top JSP relative to the document root of the Ebase web application.
void	setPdfBorder(java.lang.String pdfBorder) Sets the inline CSS style to be applied to any configured PDF borders when a page is included in a PDF.
void	setPdfFooterMarginTextClass(java.lang.String pdfFooterMarginTextClass) Sets one or more CSS classes to be applied to the PDF footer text when a page is included in a PDF.
void	setPdfFooterMarginTextStyle(java.lang.String pdfFooterMarginTextStyle) Sets the inline CSS style to be applied to the PDF footer text when a page is included in a PDF.
void	setPdfHeaderMarginTextClass(java.lang.String pdfHeaderMarginTextClass) Sets one or more CSS classes to be applied to the PDF header text when a page is included in a PDF.
void	setPdfHeaderMarginTextStyle(java.lang.String pdfHeaderMarginTextStyle) Sets the inline CSS style to be applied to the PDF header text when a page is included in a PDF.
void	setPdfMargin(java.lang.String pdfMargin) Sets the inline CSS style to be applied to any configured PDF margins when a page is included in a PDF.
void	setPdfOrientation(java.lang.String pdfOrientation) Sets the PDF orientation when a page is included in a PDF.
void	setPdfPageSize(java.lang.String pdfPageSize) Sets the PDF page size when a page is included in a PDF.
void	setWidth(java.lang.String width) Sets the width for the page including any configured JSPs.

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

getLayout, getLayoutType

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

getChildControls

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

getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show

Methods inherited from interface com.ebasetech.xi.api.Element

getElementName, getElementType

Methods inherited from interface com.ebasetech.xi.api.MessageContainer

addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, existErrorMessages, existMessages, existWarningMessages

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

getErrorMessageStyle, getWarningMessageStyle

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.BorderStyleProperties

getBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidth

Method Detail

getWidth

java.lang.String getWidth()

Page width. Since the Page Control is the root control, a width specified for this control acts as the 100% value for all child containers that specify % widths. See setWidth(String) for details of supported values when setting this property.

Since:

V4.4

setWidth

void setWidth(java.lang.String width)

Sets the width for the page including any configured JSPs.

Since the Page Control is the root control, a width specified for this control acts as the 100% value for all child containers that specify % widths. Removing this width specification subsequently can cause a page to appear to collapse: this is because child controls may have a width of 100% specified, but there is no parent width value established so this is interpreted as 100% of nothing.

Supported values:

Value	Description
A specific value	As per the CSS width property e.g. 800px
null	The maximum value: uses the maximum width available to the browser. This width will include any configured padding, border or margins for the page.

Examples:

 controls.PAGE1.width = "800px";
 controls.PANEL1.width = "50%";
 controls.PANEL1.setWidth(null);
 

Since:

V4.4

getAlignment

java.lang.String getAlignment()

Specifies the horizontal alignment for the entire page within the browser window.

Since:

V4.4

See Also:

setAlignment(String)

setAlignment

void setAlignment(java.lang.String alignment)

Sets the horizontal alignment for the entire page within the browser window.

Supported values:

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

Since:

V4.4

getFormHeaderProperties

FormHeaderProperties getFormHeaderProperties()

Form header properties.

Since:

V4.4

getContentsHeight

java.lang.String getContentsHeight()

The height of the page contents area.

Since:

V4.4

setContentsHeight

void setContentsHeight(java.lang.String contentsHeight)

Sets the height of the page contents area. Any valid value for the CSS height property can be used.

Since:

V4.4

getContentsTextProperties

TextStyleProperties getContentsTextProperties()

The default text properties for the page.

Since:

V4.4

getContentsBackgroundProperties

BackgroundStyleProperties getContentsBackgroundProperties()

Background properties for the page contents.

Since:

V4.4

getContentsBorderProperties

BorderStyleProperties getContentsBorderProperties()

Border properties for the page contents.

Since:

V4.4

getPDFPageStyleProperties

PDFPageStyleProperties getPDFPageStyleProperties()

Styling properties that apply only when the page is printed to a PDF.

Further documentation.

Since:

V4.4

See Also:

WebForm.generatePdf()

getJSPTop

java.lang.String getJSPTop()

The URL of the top JSP relative to the document root of the Ebase web application. Only files within the Ebase web application can be included as a JSP.

Further documentation.

Since:

V4.4

setJSPTop

void setJSPTop(java.lang.String jSPTop)

Sets the URL of the top JSP relative to the document root of the Ebase web application. Only files within the Ebase web application can be included as a JSP.

Further documentation.

Since:

V4.4

getJSPLeft

java.lang.String getJSPLeft()

The URL of the left JSP relative to the document root of the Ebase web application. Only files within the Ebase web application can be included as a JSP.

Further documentation.

Since:

V4.4

setJSPLeft

void setJSPLeft(java.lang.String jSPLeft)

Sets the URL of the left JSP relative to the document root of the Ebase web application. Only files within the Ebase web application can be included as a JSP.

Further documentation.

Since:

V4.4

getJSPBottom

java.lang.String getJSPBottom()

The URL of the bottom JSP relative to the document root of the Ebase web application. Only files within the Ebase web application can be included as a JSP.

Further documentation.

Since:

V4.4

setJSPBottom

void setJSPBottom(java.lang.String jSPBottom)

Sets the URL of the bottom JSP relative to the document root of the Ebase web application. Only files within the Ebase web application can be included as a JSP.

Further documentation.

Since:

V4.4

getJSPRight

java.lang.String getJSPRight()

The URL of the right JSP relative to the document root of the Ebase web application. Only files within the Ebase web application can be included as a JSP.

Further documentation.

Since:

V4.4

setJSPRight

void setJSPRight(java.lang.String jSPRight)

Sets the URL of the right JSP relative to the document root of the Ebase web application. Only files within the Ebase web application can be included as a JSP.

Further documentation.

Since:

V4.4

getJSPLeftWidth

java.lang.String getJSPLeftWidth()

Left JSP width. See setJSPLeftWidth(String) for details of supported values when setting this property.

Further documentation.

Since:

V4.4

setJSPLeftWidth

void setJSPLeftWidth(java.lang.String jSPLeftWidth)

Sets the left JSP width.

Any valid value for the CSS width property can be specified e.g. 300px

Further documentation.

Since:

V4.4

getJSPRightWidth

java.lang.String getJSPRightWidth()

Right JSP width. See setJSPRightWidth(String) for details of supported values when setting this property.

Further documentation.

Since:

V4.4

setJSPRightWidth

void setJSPRightWidth(java.lang.String jSPRightWidth)

Sets the right JSP width.

Any valid value for the CSS width property can be specified e.g. 300px

Further documentation.

Since:

V4.4

getFormPanelWidth

java.lang.String getFormPanelWidth()

Form panel width. See setFormPanelWidth(String) for details of supported values when setting this property.

Further documentation.

Since:

V4.4

setFormPanelWidth

void setFormPanelWidth(java.lang.String formPanelWidth)

Sets the form panel width.

Any valid value for the CSS width property can be specified e.g. 300px

Further documentation.

Since:

V4.4

getContentClass

java.lang.String getContentClass()

Returns the list of CSS classes applied to the page content. Style configured here is applied to all child controls but excludes the Form Header panel and surrounding JSPs.

These classes are configured in the designer using the Advanced Properties button within the Table Control Styling Assistant.

Since:

V4.4

See Also:

setContentClass(String)

setContentClass

void setContentClass(java.lang.String contentClass)

Sets one or more CSS classes to be applied to the page content. Style configured here is applied to all child controls but excludes the Form Header panel and surrounding JSPs. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

These classes are configured in the designer using the Advanced Properties button within the Table Control Styling Assistant.

Since:

V4.4

getContentStyle

java.lang.String getContentStyle()

Returns the inline CSS style applied to the page content. Style configured here is applied to all child controls but excludes the Form Header panel and surrounding JSPs.

This inline style is configured in the designer using the Advanced Properties button within the Table Control Styling Assistant.

Since:

V4.4

See Also:

setContentStyle(String)

setContentStyle

void setContentStyle(java.lang.String contentStyle)

Sets the inline CSS style to be applied to the page content. Style configured here is applied to all child controls but excludes the Form Header panel and surrounding JSPs. Style is entered as for the HTML style parameter.

This inline style is configured in the designer using the Advanced Properties button within the Table Control Styling Assistant.

Since:

V4.4

getPdfPageSize

java.lang.String getPdfPageSize()

Returns the PDF page size when a page is included in a PDF.

Further documentation.

Since:

V4.4

See Also:

setPdfPageSize(String), WebForm.generatePdf()

setPdfPageSize

void setPdfPageSize(java.lang.String pdfPageSize)

Sets the PDF page size when a page is included in a PDF. Any valid value for the CSS3 @page size property can be specified, e.g. A4, A5, Letter, Legal, 8.5in 11.5in.

Further documentation.

Since:

V4.4

See Also:

WebForm.generatePdf()

getPdfOrientation

java.lang.String getPdfOrientation()

Returns the PDF orientation, portrait or landscape, when a page is included in a PDF.

Further documentation.

Since:

V4.4

See Also:

setPdfOrientation(String), WebForm.generatePdf()

setPdfOrientation

void setPdfOrientation(java.lang.String pdfOrientation)

Sets the PDF orientation when a page is included in a PDF.

Supported values:

Value	Constant
portrait	ControlConstants.PDF_ORIENTATION_PORTRAIT
landscape	ControlConstants.PDF_ORIENTATION_LANDSCAPE

Further documentation.

Example:

 controls.PAGE1.pdfOrientation = ControlConstants.PDF_ORIENTATION_LANDSCAPE;
 

Since:

V4.4

See Also:

WebForm.generatePdf()

getPdfMargin

java.lang.String getPdfMargin()

Returns the inline CSS style applied to any configured PDF margins when a page is included in a PDF.

Further documentation.

Since:

V4.4

See Also:

setPdfMargin(String), WebForm.generatePdf()

setPdfMargin

void setPdfMargin(java.lang.String pdfMargin)

Sets the inline CSS style to be applied to any configured PDF margins when a page is included in a PDF. Style is entered as for the HTML style parameter.

Further documentation.

Since:

V4.4

See Also:

WebForm.generatePdf()

getPdfBorder

java.lang.String getPdfBorder()

Returns the inline CSS style applied to any configured PDF borders when a page is included in a PDF.

Further documentation.

Since:

V4.4

See Also:

setPdfBorder(String), WebForm.generatePdf()

setPdfBorder

void setPdfBorder(java.lang.String pdfBorder)

Sets the inline CSS style to be applied to any configured PDF borders when a page is included in a PDF. Style is entered as for the HTML style parameter.

Further documentation.

Since:

V4.4

See Also:

WebForm.generatePdf()

getPdfHeaderText

Text getPdfHeaderText()

Returns the Text object for the PDF header text when a page is included in a PDF.

Further documentation.

Since:

V4.4

See Also:

WebForm.generatePdf()

getPdfHeaderMarginTextStyle

java.lang.String getPdfHeaderMarginTextStyle()

Returns the inline CSS style applied to the PDF header text when a page is included in a PDF.

Since:

V4.4

See Also:

getPdfHeaderText(), setPdfHeaderMarginTextStyle(String)

setPdfHeaderMarginTextStyle

void setPdfHeaderMarginTextStyle(java.lang.String pdfHeaderMarginTextStyle)

Sets the inline CSS style to be applied to the PDF header text when a page is included in a PDF. Style is entered as for the HTML style parameter.

Since:

V4.4

See Also:

getPdfHeaderText()

getPdfHeaderMarginTextClass

java.lang.String getPdfHeaderMarginTextClass()

Returns the list of CSS classes applied to the PDF header text when a page is included in a PDF.

Since:

V4.4

See Also:

getPdfHeaderText(), setPdfHeaderMarginTextClass(String)

setPdfHeaderMarginTextClass

void setPdfHeaderMarginTextClass(java.lang.String pdfHeaderMarginTextClass)

Sets one or more CSS classes to be applied to the PDF header text when a page is included in a PDF. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

Since:

V4.4

See Also:

getPdfHeaderText()

getPdfFooterText

Text getPdfFooterText()

Returns the Text object for the PDF footer text when a page is included in a PDF.

Further documentation.

Since:

V4.4

See Also:

WebForm.generatePdf()

getPdfFooterMarginTextStyle

java.lang.String getPdfFooterMarginTextStyle()

Returns the inline CSS style applied to the PDF footer text when a page is included in a PDF.

Since:

V4.4

See Also:

getPdfFooterText(), setPdfFooterMarginTextStyle(String)

setPdfFooterMarginTextStyle

void setPdfFooterMarginTextStyle(java.lang.String pdfFooterMarginTextStyle)

Sets the inline CSS style to be applied to the PDF footer text when a page is included in a PDF. Style is entered as for the HTML style parameter.

Since:

V4.4

See Also:

getPdfFooterText()

getPdfFooterMarginTextClass

java.lang.String getPdfFooterMarginTextClass()

Returns the list of CSS classes applied to the PDF footer text when a page is included in a PDF.

Since:

V4.4

See Also:

getPdfFooterText(), setPdfFooterMarginTextClass(String)

setPdfFooterMarginTextClass

void setPdfFooterMarginTextClass(java.lang.String pdfFooterMarginTextClass)

Sets one or more CSS classes to be applied to the PDF footer text when a page is included in a PDF. Multiple classes are specified by using a space between the class names, as per the HTML class parameter.

Since:

V4.4

See Also:

getPdfFooterText()