Interface PageNavigationPanel
- All Superinterfaces:
BackgroundStyleProperties
,BorderStyleProperties
,Control
,Element
,EventOwner
,MarginStyleProperties
,MessageContainer
,java.io.Serializable
,TextStyleProperties
,WebFormEventOwner
public interface PageNavigationPanel extends Control, BackgroundStyleProperties, TextStyleProperties, MarginStyleProperties, BorderStyleProperties
- Save
- Restore
- Previous Page
- Next Page
- Finish
-
Method Summary
Modifier and Type Method Description PageNavigationButtonStyle
getFinish()
Styling properties for the finish button.java.lang.String
getFinishClass()
Returns the list of CSS classes applied to the finish button.HtmlElementProperties
getFinishHtmlElementProperties()
Return the finish buttonHTMLElementProperties
of the Page Navigation Controljava.lang.String
getFinishImageUrl()
Returns the URL of the image when propertyfinishDisplayAsImage
istrue
.java.lang.String
getFinishStyle()
Returns the inline CSS style applied to the finish button.PageNavigationButtonStyle
getGlobal()
Default styling properties for all navigation buttons within the panel.PageNavigationButtonStyle
getNext()
Styling properties for the next page button.java.lang.String
getNextClass()
Returns the list of CSS classes applied to the next page button.HtmlElementProperties
getNextHtmlElementProperties()
Return the next buttonHTMLElementProperties
of the Page Navigation Controljava.lang.String
getNextImageUrl()
Returns the URL of the image when propertynextDisplayAsImage
istrue
.java.lang.String
getNextStyle()
Returns the inline CSS style applied to the next page button.java.lang.String
getPrevClass()
Returns the list of CSS classes applied to the previous page button.java.lang.String
getPrevImageUrl()
Returns the URL of the image when propertyprevDisplayAsImage
istrue
.PageNavigationButtonStyle
getPrevious()
Styling properties for the previous page button.HtmlElementProperties
getPreviousHtmlElementProperties()
Return the previous buttonHTMLElementProperties
of the Page Navigation Controljava.lang.String
getPrevStyle()
Returns the inline CSS style applied to the previous page button.PageNavigationButtonStyle
getRestore()
Styling properties for the restore button.java.lang.String
getRestoreClass()
Returns the list of CSS classes applied to the restore button.HtmlElementProperties
getRestoreHtmlElementProperties()
Return the restore buttonHTMLElementProperties
of the Page Navigation Controljava.lang.String
getRestoreImageUrl()
Returns the URL of the image when propertyrestoreDisplayAsImage
istrue
.java.lang.String
getRestoreStyle()
Returns the inline CSS style applied to the restore button.PageNavigationButtonStyle
getSave()
Styling properties for the save button.java.lang.String
getSaveClass()
Returns the list of CSS classes applied to the save button.HtmlElementProperties
getSaveHtmlElementProperties()
Return the save buttonHTMLElementProperties
of the Page Navigation Controljava.lang.String
getSaveImageUrl()
Returns the URL of the image when propertysaveDisplayAsImage
istrue
.java.lang.String
getSaveStyle()
Returns the inline CSS style applied to the save button.java.lang.String
getWidth()
Width of the Pave Navigation Panel.boolean
isFinishDisplayAsImage()
Indicates whether or not the finish button is displayed as an image.boolean
isNextDisplayAsImage()
Indicates whether or not the next page button is displayed as an image.boolean
isPrevDisplayAsImage()
Indicates whether or not the previous page button is displayed as an image.boolean
isRestoreDisplayAsImage()
Indicates whether or not the restore button is displayed as an image.boolean
isSaveDisplayAsImage()
Indicates whether or not the save button is displayed as an image.void
setFinishClass(java.lang.String finishClass)
Sets one or more CSS classes to be applied to the finish button.void
setFinishDisplayAsImage(boolean finishDisplayAsImage)
Sets whether or not the finish button is displayed as an image.void
setFinishImageUrl(java.lang.String finishImageUrl)
Sets the URL of the image when propertyfinishDisplayAsImage
istrue
.void
setFinishStyle(java.lang.String finishStyle)
Sets the inline CSS style to be applied to the finish button.void
setNextClass(java.lang.String nextClass)
Sets one or more CSS classes to be applied to the next page button.void
setNextDisplayAsImage(boolean nextDisplayAsImage)
Sets whether or not the next page button is displayed as an image.void
setNextImageUrl(java.lang.String nextImageUrl)
Sets the URL of the image when propertynextDisplayAsImage
istrue
.void
setNextStyle(java.lang.String nextStyle)
Sets the inline CSS style to be applied to the next page button.void
setPrevClass(java.lang.String prevClass)
Sets one or more CSS classes to be applied to the previous page button.void
setPrevDisplayAsImage(boolean prevDisplayAsImage)
Sets whether or not the previous page button is displayed as an image.void
setPrevImageUrl(java.lang.String prevImageUrl)
Sets the URL of the image when propertyprevDisplayAsImage
istrue
.void
setPrevStyle(java.lang.String prevStyle)
Sets the inline CSS style to be applied to the previous page button.void
setRestoreClass(java.lang.String restoreClass)
Sets one or more CSS classes to be applied to the restore button.void
setRestoreDisplayAsImage(boolean restoreDisplayAsImage)
Sets whether or not the restore button is displayed as an image.void
setRestoreImageUrl(java.lang.String restoreImageUrl)
Sets the URL of the image when propertyrestoreDisplayAsImage
istrue
.void
setRestoreStyle(java.lang.String restoreStyle)
Sets the inline CSS style to be applied to the restore button.void
setSaveClass(java.lang.String saveClass)
Sets one or more CSS classes to be applied to the save button.void
setSaveDisplayAsImage(boolean saveDisplayAsImage)
Sets whether or not the save button is displayed as an image.void
setSaveImageUrl(java.lang.String saveImageUrl)
Sets the URL of the image when propertysaveDisplayAsImage
istrue
.void
setSaveStyle(java.lang.String saveStyle)
Sets the inline CSS style to be applied to the save button.void
setWidth(java.lang.String width)
Sets the width of the Pave Navigation Panel.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
Methods inherited from interface com.ebasetech.xi.api.controls.Control
addCssClass, getAll, getCssClass, getErrorMsgClass, getErrorMsgStyle, getInfoMsgClass, getInfoMsgStyle, getLayoutCell, getNextSiblingControl, getPage, getParentControl, getPreviousSiblingControl, getRootHtmlElementProperties, 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
Methods inherited from interface com.ebasetech.xi.api.Element
getElementName, getElementType
Methods inherited from interface com.ebasetech.xi.api.controls.MarginStyleProperties
getAllMargin, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, setAllMargin, setBottomMargin, setLeftMargin, setRightMargin, setTopMargin
Methods inherited from interface com.ebasetech.xi.api.MessageContainer
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
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
-
getWidth
java.lang.String getWidth()Width of the Pave Navigation Panel. SeesetWidth(String)
for details of supported values when setting this property.- Since:
- V4.4
-
setWidth
void setWidth(java.lang.String width)Sets the width of the Pave Navigation Panel.Any valid value for the CSS width property can be specified e.g. 300px
- Since:
- V4.4
-
getGlobal
PageNavigationButtonStyle getGlobal()Default styling properties for all navigation buttons within the panel.- Since:
- V4.4
-
getNext
PageNavigationButtonStyle getNext()Styling properties for the next page button. These properties override anydefault properties
configured.- Since:
- V4.4
-
getPrevious
PageNavigationButtonStyle getPrevious()Styling properties for the previous page button. These properties override anydefault properties
configured.- Since:
- V4.4
-
getSave
PageNavigationButtonStyle getSave()Styling properties for the save button. These properties override anydefault properties
configured.- Since:
- V4.4
-
getRestore
PageNavigationButtonStyle getRestore()Styling properties for the restore button. These properties override anydefault properties
configured.- Since:
- V4.4
-
getFinish
PageNavigationButtonStyle getFinish()Styling properties for the finish button. These properties override anydefault properties
configured.- Since:
- V4.4
-
isSaveDisplayAsImage
boolean isSaveDisplayAsImage()Indicates whether or not the save button is displayed as an image. The image URL can be configured using thesaveImageUrl
property.- Since:
- V4.4
-
setSaveDisplayAsImage
void setSaveDisplayAsImage(boolean saveDisplayAsImage)Sets whether or not the save button is displayed as an image. The image URL can be configured using thesetSaveImageUrl(String)
method.- Since:
- V4.4
-
getSaveImageUrl
java.lang.String getSaveImageUrl()Returns the URL of the image when propertysaveDisplayAsImage
istrue
. The URL can be either relative or absolute.- Since:
- V4.4
-
setSaveImageUrl
void setSaveImageUrl(java.lang.String saveImageUrl)Sets the URL of the image when propertysaveDisplayAsImage
istrue
. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g.http://www.google.com
.- Since:
- V4.4
-
getSaveClass
java.lang.String getSaveClass()Returns the list of CSS classes applied to the save button.These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setSaveClass(String)
-
setSaveClass
void setSaveClass(java.lang.String saveClass)Sets one or more CSS classes to be applied to the save button. 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 control's Styling Assistant.
- Since:
- V4.4
-
getSaveStyle
java.lang.String getSaveStyle()Returns the inline CSS style applied to the save button.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setSaveStyle(String)
-
setSaveStyle
void setSaveStyle(java.lang.String saveStyle)Sets the inline CSS style to be applied to the save button. Style is entered as for the HTML style parameter.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
-
isRestoreDisplayAsImage
boolean isRestoreDisplayAsImage()Indicates whether or not the restore button is displayed as an image. The image URL can be configured using therestoreImageUrl
property.- Since:
- V4.4
-
setRestoreDisplayAsImage
void setRestoreDisplayAsImage(boolean restoreDisplayAsImage)Sets whether or not the restore button is displayed as an image. The image URL can be configured using thesetRestoreImageUrl(String)
method.- Since:
- V4.4
-
getRestoreImageUrl
java.lang.String getRestoreImageUrl()Returns the URL of the image when propertyrestoreDisplayAsImage
istrue
. The URL can be either relative or absolute.- Since:
- V4.4
-
setRestoreImageUrl
void setRestoreImageUrl(java.lang.String restoreImageUrl)Sets the URL of the image when propertyrestoreDisplayAsImage
istrue
. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g.http://www.google.com
.- Since:
- V4.4
-
getRestoreClass
java.lang.String getRestoreClass()Returns the list of CSS classes applied to the restore button.These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setRestoreClass(String)
-
setRestoreClass
void setRestoreClass(java.lang.String restoreClass)Sets one or more CSS classes to be applied to the restore button. 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 control's Styling Assistant.
- Since:
- V4.4
-
getRestoreStyle
java.lang.String getRestoreStyle()Returns the inline CSS style applied to the restore button.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setRestoreStyle(String)
-
setRestoreStyle
void setRestoreStyle(java.lang.String restoreStyle)Sets the inline CSS style to be applied to the restore button. Style is entered as for the HTML style parameter.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
-
isNextDisplayAsImage
boolean isNextDisplayAsImage()Indicates whether or not the next page button is displayed as an image. The image URL can be configured using thenextImageUrl
property.- Since:
- V4.4
-
setNextDisplayAsImage
void setNextDisplayAsImage(boolean nextDisplayAsImage)Sets whether or not the next page button is displayed as an image. The image URL can be configured using thesetNextImageUrl(String)
method.- Since:
- V4.4
-
getNextImageUrl
java.lang.String getNextImageUrl()Returns the URL of the image when propertynextDisplayAsImage
istrue
. The URL can be either relative or absolute.- Since:
- V4.4
-
setNextImageUrl
void setNextImageUrl(java.lang.String nextImageUrl)Sets the URL of the image when propertynextDisplayAsImage
istrue
. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g.http://www.google.com
.- Since:
- V4.4
-
getNextClass
java.lang.String getNextClass()Returns the list of CSS classes applied to the next page button.These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setNextClass(String)
-
setNextClass
void setNextClass(java.lang.String nextClass)Sets one or more CSS classes to be applied to the next page button. 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 control's Styling Assistant.
- Since:
- V4.4
-
getNextStyle
java.lang.String getNextStyle()Returns the inline CSS style applied to the next page button.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setNextStyle(String)
-
setNextStyle
void setNextStyle(java.lang.String nextStyle)Sets the inline CSS style to be applied to the next page button. Style is entered as for the HTML style parameter.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
-
isPrevDisplayAsImage
boolean isPrevDisplayAsImage()Indicates whether or not the previous page button is displayed as an image. The image URL can be configured using theprevImageUrl
property.- Since:
- V4.4
-
setPrevDisplayAsImage
void setPrevDisplayAsImage(boolean prevDisplayAsImage)Sets whether or not the previous page button is displayed as an image. The image URL can be configured using thesetPrevImageUrl(String)
method.- Since:
- V4.4
-
getPrevImageUrl
java.lang.String getPrevImageUrl()Returns the URL of the image when propertyprevDisplayAsImage
istrue
. The URL can be either relative or absolute.- Since:
- V4.4
-
setPrevImageUrl
void setPrevImageUrl(java.lang.String prevImageUrl)Sets the URL of the image when propertyprevDisplayAsImage
istrue
. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g.http://www.google.com
.- Since:
- V4.4
-
getPrevClass
java.lang.String getPrevClass()Returns the list of CSS classes applied to the previous page button.These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setPrevClass(String)
-
setPrevClass
void setPrevClass(java.lang.String prevClass)Sets one or more CSS classes to be applied to the previous page button. 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 control's Styling Assistant.
- Since:
- V4.4
-
getPrevStyle
java.lang.String getPrevStyle()Returns the inline CSS style applied to the previous page button.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setPrevStyle(String)
-
setPrevStyle
void setPrevStyle(java.lang.String prevStyle)Sets the inline CSS style to be applied to the previous page button. Style is entered as for the HTML style parameter.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
-
isFinishDisplayAsImage
boolean isFinishDisplayAsImage()Indicates whether or not the finish button is displayed as an image. The image URL can be configured using thefinishImageUrl
property.- Since:
- V4.4
-
setFinishDisplayAsImage
void setFinishDisplayAsImage(boolean finishDisplayAsImage)Sets whether or not the finish button is displayed as an image. The image URL can be configured using thesetFinishImageUrl(String)
method.- Since:
- V4.4
-
getFinishImageUrl
java.lang.String getFinishImageUrl()Returns the URL of the image when propertyfinishDisplayAsImage
istrue
. The URL can be either relative or absolute.- Since:
- V4.4
-
setFinishImageUrl
void setFinishImageUrl(java.lang.String finishImageUrl)Sets the URL of the image when propertyfinishDisplayAsImage
istrue
. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g.http://www.google.com
.- Since:
- V4.4
-
getFinishClass
java.lang.String getFinishClass()Returns the list of CSS classes applied to the finish button.These classes are configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setFinishClass(String)
-
setFinishClass
void setFinishClass(java.lang.String finishClass)Sets one or more CSS classes to be applied to the finish button. 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 control's Styling Assistant.
- Since:
- V4.4
-
getFinishStyle
java.lang.String getFinishStyle()Returns the inline CSS style applied to the finish button.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
- See Also:
setFinishStyle(String)
-
setFinishStyle
void setFinishStyle(java.lang.String finishStyle)Sets the inline CSS style to be applied to the finish button. Style is entered as for the HTML style parameter.This inline style is configured in the designer using the Advanced Properties button within the control's Styling Assistant.
- Since:
- V4.4
-
getSaveHtmlElementProperties
HtmlElementProperties getSaveHtmlElementProperties()Return the save buttonHTMLElementProperties
of the Page Navigation Control- Since:
- V5.9
-
getRestoreHtmlElementProperties
HtmlElementProperties getRestoreHtmlElementProperties()Return the restore buttonHTMLElementProperties
of the Page Navigation Control- Since:
- V5.9
-
getPreviousHtmlElementProperties
HtmlElementProperties getPreviousHtmlElementProperties()Return the previous buttonHTMLElementProperties
of the Page Navigation Control- Since:
- V5.9
-
getNextHtmlElementProperties
HtmlElementProperties getNextHtmlElementProperties()Return the next buttonHTMLElementProperties
of the Page Navigation Control- Since:
- V5.9
-
getFinishHtmlElementProperties
HtmlElementProperties getFinishHtmlElementProperties()Return the finish buttonHTMLElementProperties
of the Page Navigation Control- Since:
- V5.9
-