Package com.smartsheet.api.models

Class Widget

    • Constructor Summary

      Constructors 
      Constructor Description
      Widget()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      WidgetContent getContents()
      Get the data that specifies the contents of the widget.
      Error getError()
      Gets an Error object if the widget is in an error state
      java.lang.Integer getHeight()
      Get the number of rows that the widget occupies
      java.lang.Boolean getShowTitle()
      Get flag indicating if the client should display the widget title.
      java.lang.Boolean getShowTitleIcon()
      Get flag indicating if the client should display the sheet icon.
      java.lang.String getTitle()
      Get the title of the widget.
      Format getTitleFormat()
      Get the title format descriptor string
      WidgetType getType()
      Get the type of the widget
      java.lang.Integer getVersion()
      Get the widget version number
      java.lang.Integer getWidth()
      Get the number of columns that the widget occupies
      java.lang.Integer getXPosition()
      Get the x-coordinate of widget's position on the sight.
      java.lang.Integer getYPosition()
      Get the y-coordinate of widget's position on the sight.
      Widget setContents​(WidgetContent contents)
      Set the data that specifies the contents of the widget.
      Widget setError​(Error error)
      Sets an Error object when the widget is in an error state
      Widget setHeight​(java.lang.Integer height)
      Set the number of rows that the widget occupies
      Widget setShowTitle​(java.lang.Boolean showTitle)
      Set flag indicating if the client should display the widget title.
      Widget setShowTitleIcon​(java.lang.Boolean showTitleIcon)
      Set flag indicating if the client should display the sheet icon.
      Widget setTitle​(java.lang.String title)
      Set the title of the widget.
      Widget setTitleFormat​(Format titleFormat)
      Set the title format descriptor string
      Widget setType​(WidgetType type)
      Set the type of the widget
      Widget setVersion​(java.lang.Integer version)
      Set the widget version number
      Widget setWidth​(java.lang.Integer width)
      Set the number of columns that the widget occupies
      Widget setXPosition​(java.lang.Integer xPosition)
      Set the x-coordinate of widget's position on the sight.
      Widget setYPosition​(java.lang.Integer yPosition)
      Set the y-coordinate of widget's position on the sight.

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Widget

        public Widget()

    • Method Detail

      • getType

        public WidgetType getType()
        Get the type of the widget
        Returns:
        type

      • setType

        public Widget setType​(WidgetType type)
        Set the type of the widget

      • getTitle

        public java.lang.String getTitle()
        Get the title of the widget.
        Returns:
        title

      • setTitle

        public Widget setTitle​(java.lang.String title)
        Set the title of the widget.

      • getShowTitle

        public java.lang.Boolean getShowTitle()
        Get flag indicating if the client should display the widget title.
        Returns:
        showTitle flag

      • setShowTitle

        public Widget setShowTitle​(java.lang.Boolean showTitle)
        Set flag indicating if the client should display the widget title.

      • getShowTitleIcon

        public java.lang.Boolean getShowTitleIcon()
        Get flag indicating if the client should display the sheet icon.
        Returns:
        showTitleIcon flag

      • setShowTitleIcon

        public Widget setShowTitleIcon​(java.lang.Boolean showTitleIcon)
        Set flag indicating if the client should display the sheet icon.

      • getTitleFormat

        public Format getTitleFormat()
        Get the title format descriptor string
        Returns:
        titleFormat

      • setTitleFormat

        public Widget setTitleFormat​(Format titleFormat)
        Set the title format descriptor string

      • getXPosition

        public java.lang.Integer getXPosition()
        Get the x-coordinate of widget's position on the sight.
        Returns:
        xPosition

      • setXPosition

        public Widget setXPosition​(java.lang.Integer xPosition)
        Set the x-coordinate of widget's position on the sight.

      • getYPosition

        public java.lang.Integer getYPosition()
        Get the y-coordinate of widget's position on the sight.
        Returns:
        yPosition

      • setYPosition

        public Widget setYPosition​(java.lang.Integer yPosition)
        Set the y-coordinate of widget's position on the sight.

      • getHeight

        public java.lang.Integer getHeight()
        Get the number of rows that the widget occupies
        Returns:
        height

      • setHeight

        public Widget setHeight​(java.lang.Integer height)
        Set the number of rows that the widget occupies

      • getWidth

        public java.lang.Integer getWidth()
        Get the number of columns that the widget occupies
        Returns:
        width

      • setWidth

        public Widget setWidth​(java.lang.Integer width)
        Set the number of columns that the widget occupies

      • getVersion

        public java.lang.Integer getVersion()
        Get the widget version number
        Returns:
        version

      • setVersion

        public Widget setVersion​(java.lang.Integer version)
        Set the widget version number

      • getContents

        public WidgetContent getContents()
        Get the data that specifies the contents of the widget. See description of contents variable for valid objects
        Returns:
        contents

      • setContents

        public Widget setContents​(WidgetContent contents)
        Set the data that specifies the contents of the widget. See description of contents variable for valid objects

      • getError

        public Error getError()
        Gets an Error object if the widget is in an error state
        Returns:
        error

      • setError

        public Widget setError​(Error error)
        Sets an Error object when the widget is in an error state