com.smartsheet.api.models

Class Widget

java.lang.Object

com.smartsheet.api.models.IdentifiableModel<Long>

com.smartsheet.api.models.Widget

public class Widget
extends IdentifiableModel<Long>

Constructor Summary

Constructors

Constructor and Description
Widget()

Method Summary

Modifier and Type	Method and Description
WidgetContent	getContents() Get the data that specifies the contents of the widget.
Integer	getHeight() Get the number of rows that the widget occupies
Boolean	getShowTitle() Get flag indicating if the client should display the widget title.
Boolean	getShowTitleIcon() Get flag indicating if the client should display the sheet icon.
String	getTitle() Get the title of the widget.
Format	getTitleFormat() Get the title format descriptor string
WidgetType	getType() Get the type of the widget
Integer	getVersion() Get the widget version number
Integer	getWidth() Get the number of columns that the widget occupies
Integer	getXPosition() Get the x-coordinate of widget's position on the sight.
Integer	getYPosition() Get the y-coordinate of widget's position on the sight.
Widget	setContents(WidgetContent contents) Get the data that specifies the contents of the widget.
Widget	setHeight(Integer height) Set the number of rows that the widget occupies
Widget	setShowTitle(Boolean showTitle) Set flag indicating if the client should display the widget title.
Widget	setShowTitleIcon(Boolean showTitleIcon) Set flag indicating if the client should display the sheet icon.
Widget	setTitle(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(Integer version) Set the widget version number
Widget	setWidth(Integer width) Set the number of columns that the widget occupies
Widget	setXPosition(Integer xPosition) Set the x-coordinate of widget's position on the sight.
Widget	setYPosition(Integer yPosition) Set the y-coordinate of widget's position on the sight.

Methods inherited from class com.smartsheet.api.models.IdentifiableModel

equals, getId, hashCode, setId

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

Parameters:

type -

getTitle

public String getTitle()

Get the title of the widget.

Returns:

title

setTitle

public Widget setTitle(String title)

Set the title of the widget.

Parameters:

title -

getShowTitle

public Boolean getShowTitle()

Get flag indicating if the client should display the widget title.

Returns:

showTitle flag

setShowTitle

public Widget setShowTitle(Boolean showTitle)

Set flag indicating if the client should display the widget title.

Parameters:

showTitle -

getShowTitleIcon

public Boolean getShowTitleIcon()

Get flag indicating if the client should display the sheet icon.

Returns:

showTitleIcon flag

setShowTitleIcon

public Widget setShowTitleIcon(Boolean showTitleIcon)

Set flag indicating if the client should display the sheet icon.

Parameters:

showTitleIcon -

getTitleFormat

public Format getTitleFormat()

Get the title format descriptor string

Returns:

titleFormat

setTitleFormat

public Widget setTitleFormat(Format titleFormat)

Set the title format descriptor string

Parameters:

titleFormat -

getXPosition

public Integer getXPosition()

Get the x-coordinate of widget's position on the sight.

Returns:

xPosition

setXPosition

public Widget setXPosition(Integer xPosition)

Set the x-coordinate of widget's position on the sight.

Parameters:

xPosition -

getYPosition

public Integer getYPosition()

Get the y-coordinate of widget's position on the sight.

Returns:

yPosition

setYPosition

public Widget setYPosition(Integer yPosition)

Set the y-coordinate of widget's position on the sight.

Parameters:

yPosition -

getHeight

public Integer getHeight()

Get the number of rows that the widget occupies

Returns:

height

setHeight

public Widget setHeight(Integer height)

Set the number of rows that the widget occupies

Parameters:

height -

getWidth

public Integer getWidth()

Get the number of columns that the widget occupies

Returns:

width

setWidth

public Widget setWidth(Integer width)

Set the number of columns that the widget occupies

Parameters:

width -

getVersion

public Integer getVersion()

Get the widget version number

Returns:

version

setVersion

public Widget setVersion(Integer version)

Set the widget version number

Parameters:

version -

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)

Get the data that specifies the contents of the widget. See description of contents variable for valid objects

Parameters:

contents -