Package com.ebasetech.xi.api.controls

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
A Page Navigation Control represents a panel containing up to five buttons. Each button is shown only when applicable:
  • Save
  • Restore
  • Previous Page
  • Next Page
  • Finish
Further documentation.

  • Method Details

    • getWidth

      java.lang.String getWidth()
      Width of the Pave Navigation Panel. 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 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.

      Further documentation.

      Since:
      V4.4

    • getNext

      PageNavigationButtonStyle getNext()
      Styling properties for the next page button. These properties override any default properties configured.

      Further documentation.

      Since:
      V4.4

    • getPrevious

      PageNavigationButtonStyle getPrevious()
      Styling properties for the previous page button. These properties override any default properties configured.

      Further documentation.

      Since:
      V4.4

    • getSave

      PageNavigationButtonStyle getSave()
      Styling properties for the save button. These properties override any default properties configured.

      Further documentation.

      Since:
      V4.4

    • getRestore

      PageNavigationButtonStyle getRestore()
      Styling properties for the restore button. These properties override any default properties configured.

      Further documentation.

      Since:
      V4.4

    • getFinish

      PageNavigationButtonStyle getFinish()
      Styling properties for the finish button. These properties override any default properties configured.

      Further documentation.

      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 the saveImageUrl property.

      Further documentation.

      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 the setSaveImageUrl(String) method.

      Further documentation.

      Since:
      V4.4

    • getSaveImageUrl

      java.lang.String getSaveImageUrl()
      Returns the URL of the image when property saveDisplayAsImage is true. The URL can be either relative or absolute.

      Further documentation.

      Since:
      V4.4

    • setSaveImageUrl

      void setSaveImageUrl​(java.lang.String saveImageUrl)
      Sets the URL of the image when property saveDisplayAsImage is true. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g. http://www.google.com.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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 the restoreImageUrl property.

      Further documentation.

      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 the setRestoreImageUrl(String) method.

      Further documentation.

      Since:
      V4.4

    • getRestoreImageUrl

      java.lang.String getRestoreImageUrl()
      Returns the URL of the image when property restoreDisplayAsImage is true. The URL can be either relative or absolute.

      Further documentation.

      Since:
      V4.4

    • setRestoreImageUrl

      void setRestoreImageUrl​(java.lang.String restoreImageUrl)
      Sets the URL of the image when property restoreDisplayAsImage is true. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g. http://www.google.com.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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 the nextImageUrl property.

      Further documentation.

      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 the setNextImageUrl(String) method.

      Further documentation.

      Since:
      V4.4

    • getNextImageUrl

      java.lang.String getNextImageUrl()
      Returns the URL of the image when property nextDisplayAsImage is true. The URL can be either relative or absolute.

      Further documentation.

      Since:
      V4.4

    • setNextImageUrl

      void setNextImageUrl​(java.lang.String nextImageUrl)
      Sets the URL of the image when property nextDisplayAsImage is true. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g. http://www.google.com.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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 the prevImageUrl property.

      Further documentation.

      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 the setPrevImageUrl(String) method.

      Further documentation.

      Since:
      V4.4

    • getPrevImageUrl

      java.lang.String getPrevImageUrl()
      Returns the URL of the image when property prevDisplayAsImage is true. The URL can be either relative or absolute.

      Further documentation.

      Since:
      V4.4

    • setPrevImageUrl

      void setPrevImageUrl​(java.lang.String prevImageUrl)
      Sets the URL of the image when property prevDisplayAsImage is true. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g. http://www.google.com.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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 the finishImageUrl property.

      Further documentation.

      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 the setFinishImageUrl(String) method.

      Further documentation.

      Since:
      V4.4

    • getFinishImageUrl

      java.lang.String getFinishImageUrl()
      Returns the URL of the image when property finishDisplayAsImage is true. The URL can be either relative or absolute.

      Further documentation.

      Since:
      V4.4

    • setFinishImageUrl

      void setFinishImageUrl​(java.lang.String finishImageUrl)
      Sets the URL of the image when property finishDisplayAsImage is true. The URL can be either relative or absolute. When absolute, it should start with the protocol e.g. http://www.google.com.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      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.

      Further documentation.

      Since:
      V4.4

    • getSaveHtmlElementProperties

      HtmlElementProperties getSaveHtmlElementProperties()
      Return the save button HTMLElementProperties of the Page Navigation Control
      Since:
      V5.9

    • getRestoreHtmlElementProperties

      HtmlElementProperties getRestoreHtmlElementProperties()
      Return the restore button HTMLElementProperties of the Page Navigation Control
      Since:
      V5.9

    • getPreviousHtmlElementProperties

      HtmlElementProperties getPreviousHtmlElementProperties()
      Return the previous button HTMLElementProperties of the Page Navigation Control
      Since:
      V5.9

    • getNextHtmlElementProperties

      HtmlElementProperties getNextHtmlElementProperties()
      Return the next button HTMLElementProperties of the Page Navigation Control
      Since:
      V5.9

    • getFinishHtmlElementProperties

      HtmlElementProperties getFinishHtmlElementProperties()
      Return the finish button HTMLElementProperties of the Page Navigation Control
      Since:
      V5.9