public interface PageControl extends LayoutControl, BackgroundStyleProperties, BorderStyleProperties, BootstrapContainerTypeProperties
Modifier and Type | Method and Description |
---|---|
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.
|
getLayout, getLayoutType
getChildControls
addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getStyle, getWarningMsgClass, getWarningMsgStyle, hasModifier, hide, isContainer, isDisplayOnly, isDisplayOnlyIncludingParents, isEventField, isHidden, isInheritMsg, isLocalMsg, isNewLine, isShowing, refresh, removeCssClass, requestFocus, setCssClass, setDisplayOnly, setErrorMsgClass, setErrorMsgStyle, setHidden, setInfoMsgClass, setInfoMsgStyle, setNewLine, setStyle, setWarningMsgClass, setWarningMsgStyle, show
getElementName, getElementType
addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessage, addErrorMessageText, addErrorMessageText, addErrorMessageText, addInfoMessage, addInfoMessage, addInfoMessageText, addInfoMessageText, addInfoMessageText, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessage, addWarningMessageText, addWarningMessageText, addWarningMessageText, existErrorMessages, existInfoMessages, existMessages, existWarningMessages
getErrorMessageStyle, getInfoMessageStyle, getWarningMessageStyle
getBackgroundColor, getBackgroundImage, getBackgroundImagePosition, getBackgroundImageRepeat, setBackgroundColor, setBackgroundImage, setBackgroundImagePosition, setBackgroundImageRepeat
getBorderColor, getBorderRadius, getBorderStyle, getBorderWidth, getBottomBorderWidth, getLeftBorderWidth, getRightBorderWidth, getTopBorderWidth, setBorderColor, setBorderRadius, setBorderStyle, setBorderWidth, setBottomBorderWidth, setLeftBorderWidth, setRightBorderWidth, setTopBorderWidth
getBootstrapContainerType, setBootstrapContainerType
java.lang.String getWidth()
setWidth(String)
for details of supported values when setting this property.void setWidth(java.lang.String 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. 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);
java.lang.String getAlignment()
setAlignment(String)
void setAlignment(java.lang.String alignment)
Supported values:
Value | Constant |
---|---|
Center | ControlConstants.HORIZONTAL_ALIGNMENT_CENTER |
Left | ControlConstants.HORIZONTAL_ALIGNMENT_LEFT |
Right | ControlConstants.HORIZONTAL_ALIGNMENT_RIGHT |
FormHeaderProperties getFormHeaderProperties()
java.lang.String getContentsHeight()
void setContentsHeight(java.lang.String contentsHeight)
TextStyleProperties getContentsTextProperties()
BackgroundStyleProperties getContentsBackgroundProperties()
BorderStyleProperties getContentsBorderProperties()
PDFPageStyleProperties getPDFPageStyleProperties()
WebForm.generatePdf()
java.lang.String getJSPTop()
void setJSPTop(java.lang.String jSPTop)
java.lang.String getJSPLeft()
void setJSPLeft(java.lang.String jSPLeft)
java.lang.String getJSPBottom()
void setJSPBottom(java.lang.String jSPBottom)
java.lang.String getJSPRight()
void setJSPRight(java.lang.String jSPRight)
java.lang.String getJSPLeftWidth()
setJSPLeftWidth(String)
for details of supported values when setting this property.
void setJSPLeftWidth(java.lang.String jSPLeftWidth)
Any valid value for the CSS width property can be specified e.g. 300px
java.lang.String getJSPRightWidth()
setJSPRightWidth(String)
for details of supported values when setting this property.
void setJSPRightWidth(java.lang.String jSPRightWidth)
Any valid value for the CSS width property can be specified e.g. 300px
java.lang.String getFormPanelWidth()
setFormPanelWidth(String)
for details of supported values when setting this property.
void setFormPanelWidth(java.lang.String formPanelWidth)
Any valid value for the CSS width property can be specified e.g. 300px
java.lang.String getContentClass()
These classes are configured in the designer using the Advanced Properties button within the Table Control Styling Assistant.
setContentClass(String)
void setContentClass(java.lang.String contentClass)
These classes are configured in the designer using the Advanced Properties button within the Table Control Styling Assistant.
java.lang.String getContentStyle()
This inline style is configured in the designer using the Advanced Properties button within the Table Control Styling Assistant.
setContentStyle(String)
void setContentStyle(java.lang.String contentStyle)
This inline style is configured in the designer using the Advanced Properties button within the Table Control Styling Assistant.
java.lang.String getPdfPageSize()
setPdfPageSize(String)
,
WebForm.generatePdf()
void setPdfPageSize(java.lang.String pdfPageSize)
WebForm.generatePdf()
java.lang.String getPdfOrientation()
setPdfOrientation(String)
,
WebForm.generatePdf()
void setPdfOrientation(java.lang.String pdfOrientation)
Supported values:
Value | Constant |
---|---|
portrait | ControlConstants.PDF_ORIENTATION_PORTRAIT |
landscape | ControlConstants.PDF_ORIENTATION_LANDSCAPE |
Example:
controls.PAGE1.pdfOrientation = ControlConstants.PDF_ORIENTATION_LANDSCAPE;
WebForm.generatePdf()
java.lang.String getPdfMargin()
setPdfMargin(String)
,
WebForm.generatePdf()
void setPdfMargin(java.lang.String pdfMargin)
WebForm.generatePdf()
java.lang.String getPdfBorder()
setPdfBorder(String)
,
WebForm.generatePdf()
void setPdfBorder(java.lang.String pdfBorder)
WebForm.generatePdf()
Text getPdfHeaderText()
Text
object for the PDF header text when a page is included in a PDF.
WebForm.generatePdf()
java.lang.String getPdfHeaderMarginTextStyle()
getPdfHeaderText()
,
setPdfHeaderMarginTextStyle(String)
void setPdfHeaderMarginTextStyle(java.lang.String pdfHeaderMarginTextStyle)
getPdfHeaderText()
java.lang.String getPdfHeaderMarginTextClass()
getPdfHeaderText()
,
setPdfHeaderMarginTextClass(String)
void setPdfHeaderMarginTextClass(java.lang.String pdfHeaderMarginTextClass)
getPdfHeaderText()
Text getPdfFooterText()
Text
object for the PDF footer text when a page is included in a PDF.
WebForm.generatePdf()
java.lang.String getPdfFooterMarginTextStyle()
getPdfFooterText()
,
setPdfFooterMarginTextStyle(String)
void setPdfFooterMarginTextStyle(java.lang.String pdfFooterMarginTextStyle)
getPdfFooterText()
java.lang.String getPdfFooterMarginTextClass()
getPdfFooterText()
,
setPdfFooterMarginTextClass(String)
void setPdfFooterMarginTextClass(java.lang.String pdfFooterMarginTextClass)
getPdfFooterText()