PageNavigationPanel

PageNavigationPanel Functions

getFinish	PageNavigationPanel.getFinish( )	Styling properties for the finish button.
getFinishClass	PageNavigationPanel.getFinishClass( )	Returns the list of CSS classes applied to the finish button.
setFinishClass	PageNavigationPanel.setFinishClass( finishClass )	Sets one or more CSS classes to be applied to the finish button.
isFinishDisplayAsImage	PageNavigationPanel.isFinishDisplayAsImage( )	Indicates whether or not the finish button is displayed as an image.
setFinishDisplayAsImage	PageNavigationPanel.setFinishDisplayAsImage( finishDisplayAsImage )	Sets whether or not the finish button is displayed as an image.
getFinishHtmlElementProperties	PageNavigationPanel.getFinishHtmlElementProperties( )	Return the finish button com.ebasetech.xi.api.controls.HtmlElementProperties of the Page Navigation Control
getFinishImageUrl	PageNavigationPanel.getFinishImageUrl( )	Returns the URL of the image when property #isFinishDisplayAsImage() is true.
setFinishImageUrl	PageNavigationPanel.setFinishImageUrl( finishImageUrl )	Sets the URL of the image when property #isFinishDisplayAsImage() is true.
getFinishStyle	PageNavigationPanel.getFinishStyle( )	Returns the inline CSS style applied to the finish button.
setFinishStyle	PageNavigationPanel.setFinishStyle( finishStyle )	Sets the inline CSS style to be applied to the finish button.
getGlobal	PageNavigationPanel.getGlobal( )	Default styling properties for all navigation buttons within the panel.
getNext	PageNavigationPanel.getNext( )	Styling properties for the next page button.
getNextClass	PageNavigationPanel.getNextClass( )	Returns the list of CSS classes applied to the next page button.
setNextClass	PageNavigationPanel.setNextClass( nextClass )	Sets one or more CSS classes to be applied to the next page button.
isNextDisplayAsImage	PageNavigationPanel.isNextDisplayAsImage( )	Indicates whether or not the next page button is displayed as an image.
setNextDisplayAsImage	PageNavigationPanel.setNextDisplayAsImage( nextDisplayAsImage )	Sets whether or not the next page button is displayed as an image.
getNextHtmlElementProperties	PageNavigationPanel.getNextHtmlElementProperties( )	Return the next button com.ebasetech.xi.api.controls.HtmlElementProperties of the Page Navigation Control
getNextImageUrl	PageNavigationPanel.getNextImageUrl( )	Returns the URL of the image when property #isNextDisplayAsImage() is true.
setNextImageUrl	PageNavigationPanel.setNextImageUrl( nextImageUrl )	Sets the URL of the image when property #isNextDisplayAsImage() is true.
getNextStyle	PageNavigationPanel.getNextStyle( )	Returns the inline CSS style applied to the next page button.
setNextStyle	PageNavigationPanel.setNextStyle( nextStyle )	Sets the inline CSS style to be applied to the next page button.
getPrevClass	PageNavigationPanel.getPrevClass( )	Returns the list of CSS classes applied to the previous page button.
setPrevClass	PageNavigationPanel.setPrevClass( prevClass )	Sets one or more CSS classes to be applied to the previous page button.
isPrevDisplayAsImage	PageNavigationPanel.isPrevDisplayAsImage( )	Indicates whether or not the previous page button is displayed as an image.
setPrevDisplayAsImage	PageNavigationPanel.setPrevDisplayAsImage( prevDisplayAsImage )	Sets whether or not the previous page button is displayed as an image.
getPrevImageUrl	PageNavigationPanel.getPrevImageUrl( )	Returns the URL of the image when property #isPrevDisplayAsImage() is true.
setPrevImageUrl	PageNavigationPanel.setPrevImageUrl( prevImageUrl )	Sets the URL of the image when property #isPrevDisplayAsImage() is true.
getPrevious	PageNavigationPanel.getPrevious( )	Styling properties for the previous page button.
getPreviousHtmlElementProperties	PageNavigationPanel.getPreviousHtmlElementProperties( )	Return the previous button com.ebasetech.xi.api.controls.HtmlElementProperties of the Page Navigation Control
getPrevStyle	PageNavigationPanel.getPrevStyle( )	Returns the inline CSS style applied to the previous page button.
setPrevStyle	PageNavigationPanel.setPrevStyle( prevStyle )	Sets the inline CSS style to be applied to the previous page button.
getRestore	PageNavigationPanel.getRestore( )	Styling properties for the restore button.
getRestoreClass	PageNavigationPanel.getRestoreClass( )	Returns the list of CSS classes applied to the restore button.
setRestoreClass	PageNavigationPanel.setRestoreClass( restoreClass )	Sets one or more CSS classes to be applied to the restore button.
isRestoreDisplayAsImage	PageNavigationPanel.isRestoreDisplayAsImage( )	Indicates whether or not the restore button is displayed as an image.
setRestoreDisplayAsImage	PageNavigationPanel.setRestoreDisplayAsImage( restoreDisplayAsImage )	Sets whether or not the restore button is displayed as an image.
getRestoreHtmlElementProperties	PageNavigationPanel.getRestoreHtmlElementProperties( )	Return the restore button com.ebasetech.xi.api.controls.HtmlElementProperties of the Page Navigation Control
getRestoreImageUrl	PageNavigationPanel.getRestoreImageUrl( )	Returns the URL of the image when property #isRestoreDisplayAsImage() is true.
setRestoreImageUrl	PageNavigationPanel.setRestoreImageUrl( restoreImageUrl )	Sets the URL of the image when property #isRestoreDisplayAsImage() is true.
getRestoreStyle	PageNavigationPanel.getRestoreStyle( )	Returns the inline CSS style applied to the restore button.
setRestoreStyle	PageNavigationPanel.setRestoreStyle( restoreStyle )	Sets the inline CSS style to be applied to the restore button.
getSave	PageNavigationPanel.getSave( )	Styling properties for the save button.
getSaveClass	PageNavigationPanel.getSaveClass( )	Returns the list of CSS classes applied to the save button.
setSaveClass	PageNavigationPanel.setSaveClass( saveClass )	Sets one or more CSS classes to be applied to the save button.
isSaveDisplayAsImage	PageNavigationPanel.isSaveDisplayAsImage( )	Indicates whether or not the save button is displayed as an image.
setSaveDisplayAsImage	PageNavigationPanel.setSaveDisplayAsImage( saveDisplayAsImage )	Sets whether or not the save button is displayed as an image.
getSaveHtmlElementProperties	PageNavigationPanel.getSaveHtmlElementProperties( )	Return the save button com.ebasetech.xi.api.controls.HtmlElementProperties of the Page Navigation Control
getSaveImageUrl	PageNavigationPanel.getSaveImageUrl( )	Returns the URL of the image when property #isSaveDisplayAsImage() is true.
setSaveImageUrl	PageNavigationPanel.setSaveImageUrl( saveImageUrl )	Sets the URL of the image when property #isSaveDisplayAsImage() is true.
getSaveStyle	PageNavigationPanel.getSaveStyle( )	Returns the inline CSS style applied to the save button.
setSaveStyle	PageNavigationPanel.setSaveStyle( saveStyle )	Sets the inline CSS style to be applied to the save button.
getWidth	PageNavigationPanel.getWidth( )	Width of the Pave Navigation Panel.
setWidth	PageNavigationPanel.setWidth( width )	Sets the width of the Pave Navigation Panel.

BackgroundStyleProperties Functions

getBackgroundColor	PageNavigationPanel.getBackgroundColor( )	Background color.
setBackgroundColor	PageNavigationPanel.setBackgroundColor( backgroundColor )	Sets the background color, this is equivalent to the CSS background-color property and any valid value for this CSS property can be used.
getBackgroundImage	PageNavigationPanel.getBackgroundImage( )	URL of the background image.
setBackgroundImage	PageNavigationPanel.setBackgroundImage( backgroundImage )	Sets the URL of the background image.
getBackgroundImagePosition	PageNavigationPanel.getBackgroundImagePosition( )	Background image position.
setBackgroundImagePosition	PageNavigationPanel.setBackgroundImagePosition( backgroundImagePosition )	Sets the background image position.
getBackgroundImageRepeat	PageNavigationPanel.getBackgroundImageRepeat( )	Background image repeat property.
setBackgroundImageRepeat	PageNavigationPanel.setBackgroundImageRepeat( backgroundImageRepeat )	Sets the background image repeat property.

BorderStyleProperties Functions

getBorderColor	PageNavigationPanel.getBorderColor( )	Border color applied to all borders.
setBorderColor	PageNavigationPanel.setBorderColor( borderColor )	Sets border color.
getBorderRadius	PageNavigationPanel.getBorderRadius( )	Border radius.
setBorderRadius	PageNavigationPanel.setBorderRadius( borderRadius )	Sets border radius.
getBorderStyle	PageNavigationPanel.getBorderStyle( )	Border style applied to all borders.
setBorderStyle	PageNavigationPanel.setBorderStyle( borderStyle )	Sets border style.
getBorderWidth	PageNavigationPanel.getBorderWidth( )	Border width applied to all four borders.
setBorderWidth	PageNavigationPanel.setBorderWidth( borderWidth )	Sets the border width applied to all four borders.
getBottomBorderWidth	PageNavigationPanel.getBottomBorderWidth( )	Bottom border width, overriding property borderWidth.
setBottomBorderWidth	PageNavigationPanel.setBottomBorderWidth( bottomBorderWidth )	Sets the bottom border width, overriding property borderWidth.
getLeftBorderWidth	PageNavigationPanel.getLeftBorderWidth( )	Left border width, overriding property borderWidth.
setLeftBorderWidth	PageNavigationPanel.setLeftBorderWidth( leftBorderWidth )	Sets the left border width, overriding property borderWidth.
getRightBorderWidth	PageNavigationPanel.getRightBorderWidth( )	Right border width, overriding property borderWidth.
setRightBorderWidth	PageNavigationPanel.setRightBorderWidth( rightBorderWidth )	Sets the right border width, overriding property borderWidth.
getTopBorderWidth	PageNavigationPanel.getTopBorderWidth( )	Top border width, overriding property borderWidth.
setTopBorderWidth	PageNavigationPanel.setTopBorderWidth( topBorderWidth )	Sets the top border width, overriding property borderWidth.

Control Functions

addCssClass	PageNavigationPanel.addCssClass( cssClass )	Adds one or more CSS classes to the list of classes applied to the control, retaining any existing classes.
getAll	PageNavigationPanel.getAll( )	Returns a control object of the same type as the control object on which this method is invoked, that gives access to all occurrences of this control on the page.
isContainer	PageNavigationPanel.isContainer( )	Returns true if this control is a container control i.e.
getCssClass	PageNavigationPanel.getCssClass( )	Returns the list of CSS classes configured for the control.
setCssClass	PageNavigationPanel.setCssClass( cssClass )	Sets one or more CSS classes to be applied to the control.
isDisplayOnly	PageNavigationPanel.isDisplayOnly( )	Returns true if the control is marked as display only, otherwise returns false.
setDisplayOnly	PageNavigationPanel.setDisplayOnly( displayOnly )	Marks the control and all its children as display only (when displayOnly is true) or enterable (when displayOnly is false).
isDisplayOnlyIncludingParents	PageNavigationPanel.isDisplayOnlyIncludingParents( )	Returns true if the control or any of its parents is marked as display only, otherwise returns false.
getErrorMsgClass	PageNavigationPanel.getErrorMsgClass( )	Returns the list of CSS classes configured for error messages when the messages are displayed locally to the control.
setErrorMsgClass	PageNavigationPanel.setErrorMsgClass( errorMsgClass )	Sets one or more CSS classes to be applied to error messages when the messages are displayed locally to the control.
getErrorMsgStyle	PageNavigationPanel.getErrorMsgStyle( )	Returns the inline CSS style configured for error messages when the messages are displayed locally to the control.
setErrorMsgStyle	PageNavigationPanel.setErrorMsgStyle( errorMsgStyle )	Sets inline CSS style to be applied to error messages when the messages are displayed locally to the control.
isEventField	PageNavigationPanel.isEventField( )	Returns true if the control is an event field i.e.
hasModifier	PageNavigationPanel.hasModifier( modifier )	Returns true if the control has the specified modifier, otherwise returns false.
isHidden	PageNavigationPanel.isHidden( )	Returns true if the control is marked as hidden, otherwise returns false.
setHidden	PageNavigationPanel.setHidden( hidden )	Hides or shows the control and all its children.
hide	PageNavigationPanel.hide( )	Hides the control, this is equivalent to setting property hidden to true.
getInfoMsgClass	PageNavigationPanel.getInfoMsgClass( )	Returns the list of CSS classes configured for info messages when the messages are displayed locally to the control.
setInfoMsgClass	PageNavigationPanel.setInfoMsgClass( infoMsgClass )	Sets one or more CSS classes to be applied to info messages when the messages are displayed locally to the control.
getInfoMsgStyle	PageNavigationPanel.getInfoMsgStyle( )	Returns the inline CSS style configured for info messages when the messages are displayed locally to the control.
setInfoMsgStyle	PageNavigationPanel.setInfoMsgStyle( infoMsgStyle )	Sets inline CSS style to be applied to info messages when the messages are displayed locally to the control.
isInheritMsg	PageNavigationPanel.isInheritMsg( )	Returns true if Use parent control setting is checked in the Message Options properties for the control, otherwise returns false.
getLayoutCell	PageNavigationPanel.getLayoutCell( )	Returns the LayoutCell object which can be used to override properties of the parent control's layout as applied to this control.
isLocalMsg	PageNavigationPanel.isLocalMsg( )	Returns true if Local Message is checked in the Message Options properties for the control, otherwise returns false.
isNewLine	PageNavigationPanel.isNewLine( )	Returns the new line property.
setNewLine	PageNavigationPanel.setNewLine( newLine )	Sets or unsets the control's new line property.
getNextSiblingControl	PageNavigationPanel.getNextSiblingControl( )	Returns the control that appears after this control within the same parent, or null if no such control exists.
getPage	PageNavigationPanel.getPage( )	Returns the com.ebasetech.xi.api.Page where this control is located.
getParentControl	PageNavigationPanel.getParentControl( )	Returns this control's parent control or null if no such parent exists.
getPreviousSiblingControl	PageNavigationPanel.getPreviousSiblingControl( )	Returns the control that appears before this control within the same parent, or null if no such control exists.
refresh	PageNavigationPanel.refresh( )	Refreshes this control in the user's browser when the page is next displayed.
removeCssClass	PageNavigationPanel.removeCssClass( cssClass )	Removes one or more CSS classes from the control.
requestFocus	PageNavigationPanel.requestFocus( )	Sets the browser focus to the control.
getRootHtmlElementProperties	PageNavigationPanel.getRootHtmlElementProperties( )	Return the root com.ebasetech.xi.api.controls.HtmlElementProperties for the Control
show	PageNavigationPanel.show( )	Shows the control, this is equivalent to setting property hidden to false.
isShowing	PageNavigationPanel.isShowing( )	Returns true if the control will be included in the web page when it's next displayed to the user, otherwise returns false.
getStyle	PageNavigationPanel.getStyle( )	Returns the inline CSS style configured for the control.
setStyle	PageNavigationPanel.setStyle( style )	Sets inline CSS style to be applied to the control.
getWarningMsgClass	PageNavigationPanel.getWarningMsgClass( )	Returns the list of CSS classes configured for warning messages when the messages are displayed locally to the control.
setWarningMsgClass	PageNavigationPanel.setWarningMsgClass( warningMsgClass )	Sets one or more CSS classes to be applied to warning messages when the messages are displayed locally to the control.
getWarningMsgStyle	PageNavigationPanel.getWarningMsgStyle( )	Returns the inline CSS style configured for warning messages when the messages are displayed locally to the control.
setWarningMsgStyle	PageNavigationPanel.setWarningMsgStyle( warningMsgStyle )	Sets inline CSS style to be applied to warning messages when the messages are displayed locally to the control.

MarginStyleProperties Functions

getAllMargin	PageNavigationPanel.getAllMargin( )	Single MarginStyleProperties size value used for top, bottom, left and right margin.
setAllMargin	PageNavigationPanel.setAllMargin( allMargin )	Sets the MarginStyleProperties size value used for top, bottom, left and right margin.
getBottomMargin	PageNavigationPanel.getBottomMargin( )	Bottom MarginStyleProperties size value.
setBottomMargin	PageNavigationPanel.setBottomMargin( bottomMargin )	Sets the bottom MarginStyleProperties size value.
getLeftMargin	PageNavigationPanel.getLeftMargin( )	Left MarginStyleProperties size value.
setLeftMargin	PageNavigationPanel.setLeftMargin( leftMargin )	Sets the left MarginStyleProperties size value.
getRightMargin	PageNavigationPanel.getRightMargin( )	Right MarginStyleProperties size value.
setRightMargin	PageNavigationPanel.setRightMargin( rightMargin )	Sets the right MarginStyleProperties size value.
getTopMargin	PageNavigationPanel.getTopMargin( )	Top MarginStyleProperties size value.
setTopMargin	PageNavigationPanel.setTopMargin( topMargin )	Sets the top MarginStyleProperties size value.

TextStyleProperties Functions

getLineHeight	PageNavigationPanel.getLineHeight( )	Line height.
setLineHeight	PageNavigationPanel.setLineHeight( lineHeight )	Sets the line height, this is equivalent to the CSS line-height property and any valid value for this CSS property can be used.
getTextBold	PageNavigationPanel.getTextBold( )	Text bold setting.
setTextBold	PageNavigationPanel.setTextBold( textBold )	Sets the text bold setting.
getTextColor	PageNavigationPanel.getTextColor( )	Text color.
setTextColor	PageNavigationPanel.setTextColor( textColor )	Sets the text color, this is equivalent to the CSS color property and any valid value for this CSS property can be used.
getTextDecoration	PageNavigationPanel.getTextDecoration( )	Text decoration property (shown as Lines in the designer).
setTextDecoration	PageNavigationPanel.setTextDecoration( textDecoration )	Sets the text decoration property (shown as Lines in the designer).
getTextFont	PageNavigationPanel.getTextFont( )	List of text fonts.
setTextFont	PageNavigationPanel.setTextFont( textFont )	Sets the list of text fonts, this is equivalent to the CSS font-family property and any valid value for this CSS property can be used.
getTextItalic	PageNavigationPanel.getTextItalic( )	Text italic setting.
setTextItalic	PageNavigationPanel.setTextItalic( textItalic )	Sets the text italic setting.
getTextSize	PageNavigationPanel.getTextSize( )	Text size.
setTextSize	PageNavigationPanel.setTextSize( textSize )	Sets the text size, this is equivalent to the CSS font-size property and any valid value for this CSS property can be used.

MessageContainer Functions

addErrorMessage	PageNavigationPanel.addErrorMessage( message [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessage	PageNavigationPanel.addErrorMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user.
addErrorMessageText	PageNavigationPanel.addErrorMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an error message that will be displayed to the user, sourced from an existing text.
addInfoMessage	PageNavigationPanel.addInfoMessage( message [, stopProcessing ] )	Adds an information message that will be displayed to the user.
addInfoMessageText	PageNavigationPanel.addInfoMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds an info message that will be displayed to the user, sourced from an existing text.
addWarningMessage	PageNavigationPanel.addWarningMessage( message [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessage	PageNavigationPanel.addWarningMessage( messageNo [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user.
addWarningMessageText	PageNavigationPanel.addWarningMessageText( text [, replaceParameters ] [, stopProcessing ] )	Adds a warning message that will be displayed to the user, sourced from an existing text.
existErrorMessages	PageNavigationPanel.existErrorMessages( )	Returns true if undisplayed error messages exist for this element, otherwise returns false.
existInfoMessages	PageNavigationPanel.existInfoMessages( )	Returns true if undisplayed info messages exist for this element, otherwise returns false.
existMessages	PageNavigationPanel.existMessages( )	Returns true if undisplayed info, warning or error messages exist for this element, otherwise returns false.
existWarningMessages	PageNavigationPanel.existWarningMessages( )	Returns true if undisplayed warning messages exist for this element, otherwise returns false.

Element Functions

getElementName	PageNavigationPanel.getElementName( )	Returns the element name
getElementType	PageNavigationPanel.getElementType( )	Returns the element type