Package com.ebasetech.xi.api.controls

Interface InfoPopupProperties

public interface InfoPopupProperties
The InfoPopupProperties interface represents the properties passed to the Javascript window.open() statement used to create the popup window for field help texts.

Further documentation.

Since:
V4.4

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getHeight()
    Window height.
    java.lang.String getLeftPosition()
    The x position of the window's top-left corner.
    java.lang.String getTopPosition()
    The y position of the window's top-left corner.
    java.lang.String getWidth()
    Window width.
    boolean isLocation()  
    boolean isMenuBar()
    Returns true if the popup window should display the browser menu bar, otherwise returns false.
    boolean isResizable()
    Returns true if the popup window should be resizable, otherwise returns false.
    boolean isScrollBar()
    Returns true if the popup window should display scroll bars when applicable, otherwise returns false.
    boolean isStatusBar()
    Returns true if the popup window should display the browser status line, otherwise returns false.
    boolean isToolBar()
    Returns true if the popup window should display the browser tool bar with forward and back buttons etc, otherwise returns false.
    void setHeight​(java.lang.String height)
    Sets the window height.
    void setLeftPosition​(java.lang.String leftPosition)
    Sets the x position of the window's top-left corner.
    void setLocation​(boolean location)  
    void setMenuBar​(boolean menuBar)
    Sets whether or not the browser menu bar should be displayed.
    void setResizable​(boolean resizable)
    Sets whether or not the popup window can be resized by the user.
    void setScrollBar​(boolean scrollBar)
    Sets whether or not the popup window should display scroll bars when applicable.
    void setStatusBar​(boolean statusBar)
    Sets whether or not the browser status line should be displayed.
    void setToolBar​(boolean toolBar)
    Sets whether or not the browser tool bar should be displayed.
    void setTopPosition​(java.lang.String topPosition)
    Sets the y position of the window's top-left corner.
    void setWidth​(java.lang.String width)
    Sets the window width.

  • Method Details

    • isScrollBar

      boolean isScrollBar()
      Returns true if the popup window should display scroll bars when applicable, otherwise returns false.
      Since:
      V4.4

    • setScrollBar

      void setScrollBar​(boolean scrollBar)
      Sets whether or not the popup window should display scroll bars when applicable.
      Since:
      V4.4

    • isMenuBar

      boolean isMenuBar()
      Returns true if the popup window should display the browser menu bar, otherwise returns false.
      Since:
      V4.4

    • setMenuBar

      void setMenuBar​(boolean menuBar)
      Sets whether or not the browser menu bar should be displayed.
      Since:
      V4.4

    • isStatusBar

      boolean isStatusBar()
      Returns true if the popup window should display the browser status line, otherwise returns false.
      Since:
      V4.4

    • setStatusBar

      void setStatusBar​(boolean statusBar)
      Sets whether or not the browser status line should be displayed.
      Since:
      V4.4

    • isToolBar

      boolean isToolBar()
      Returns true if the popup window should display the browser tool bar with forward and back buttons etc, otherwise returns false.
      Since:
      V4.4

    • setToolBar

      void setToolBar​(boolean toolBar)
      Sets whether or not the browser tool bar should be displayed.
      Since:
      V4.4

    • isLocation

      boolean isLocation()

    • setLocation

      void setLocation​(boolean location)

    • isResizable

      boolean isResizable()
      Returns true if the popup window should be resizable, otherwise returns false.
      Since:
      V4.4

    • setResizable

      void setResizable​(boolean resizable)
      Sets whether or not the popup window can be resized by the user.
      Since:
      V4.4

    • getLeftPosition

      java.lang.String getLeftPosition()
      The x position of the window's top-left corner.
      Since:
      V4.4
      See Also:
      setLeftPosition(String)

    • setLeftPosition

      void setLeftPosition​(java.lang.String leftPosition)
      Sets the x position of the window's top-left corner. Any valid value for the CSS width property can be specified e.g. 300px
      Since:
      V4.4

    • getTopPosition

      java.lang.String getTopPosition()
      The y position of the window's top-left corner.
      Since:
      V4.4

    • setTopPosition

      void setTopPosition​(java.lang.String topPosition)
      Sets the y position of the window's top-left corner. Any valid value for the CSS height property can be specified e.g. 300px
      Since:
      V4.4

    • getWidth

      java.lang.String getWidth()
      Window width. See setWidth(String) for details of supported values when setting this property.
      Since:
      V4.4

    • setWidth

      void setWidth​(java.lang.String width)
      Sets the window width.

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

      Since:
      V4.4

    • getHeight

      java.lang.String getHeight()
      Window height. See setHeight(String) for details of supported values when setting this property.
      Since:
      V4.4

    • setHeight

      void setHeight​(java.lang.String height)
      Sets the window height.

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

      Since:
      V4.4