com.smartsheet.api.models.format

Class Format

java.lang.Object

com.smartsheet.api.models.format.Format

public class Format
extends Object

This class represents the format as applied to a cell, row or column.

Author:

kskeem

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Format.FormatBuilder Builder class for a Format object
static class	Format.FormatSerializer

Constructor Summary

Constructors

Constructor and Description
Format() Creates a Format object with default values.
Format(String original) Constructs a Format object using the format string provided by the Smartsheet API.

Method Summary

Modifier and Type	Method and Description
Color	getBackgroundColor()
Bold	getBold()
Currency	getCurrency()
DecimalCount	getDecimalCount()
FontFamily	getFontFamily()
FontSize	getFontSize()
protected <T extends Enum<?>> T	getFormatValue(com.smartsheet.api.models.format.Format.FormatAttribute attribute, T[] values)
HorizontalAlignment	getHorizontalAlignment()
Italic	getItalic()
NumberFormat	getNumberFormat()
Strikethrough	getStrikethrough()
Color	getTaskbarColor()
Color	getTextColor()
TextWrap	getTextWrap()
ThousandsSeparator	getThousandsSeparator()
Underline	getUnderline()
VerticalAlignment	getVerticalAlignment()

Methods inherited from class java.lang.Object

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

Constructor Detail

Format

public Format(String original)

Constructs a Format object using the format string provided by the Smartsheet API. The format of the string is a comma separated list. See http://www.smartsheet.com/developers/api-documentation#h.mf6r2e3k3ftb for details

Parameters:

original - the original

Format

public Format()

Creates a Format object with default values.

Method Detail

getFormatValue

protected <T extends Enum<?>> T getFormatValue(com.smartsheet.api.models.format.Format.FormatAttribute attribute,
                                               T[] values)

getFontFamily

public FontFamily getFontFamily()

Returns:

the FontFamily.

getFontSize

public FontSize getFontSize()

Returns:

the FontSize

getBold

public Bold getBold()

Returns:

the Bold format

getItalic

public Italic getItalic()

Returns:

the Italic format

getUnderline

public Underline getUnderline()

Returns:

the Underline status

getStrikethrough

public Strikethrough getStrikethrough()

Returns:

the Strikethrough status

getHorizontalAlignment

public HorizontalAlignment getHorizontalAlignment()

Returns:

the HorizontalAlignment

getVerticalAlignment

public VerticalAlignment getVerticalAlignment()

Returns:

the VerticalAlignment

getTextColor

public Color getTextColor()

Returns:

the Color of the text.

getBackgroundColor

public Color getBackgroundColor()

Returns:

the Color of the background

getTaskbarColor

public Color getTaskbarColor()

Returns:

the Color of the task bar (gantt view)

getCurrency

public Currency getCurrency()

Returns:

the Currency format

getDecimalCount

public DecimalCount getDecimalCount()

Returns:

the DecimalCount

getThousandsSeparator

public ThousandsSeparator getThousandsSeparator()

Returns:

the ThousandsSeparator

getNumberFormat

public NumberFormat getNumberFormat()

Returns:

the NumberFormat

getTextWrap

public TextWrap getTextWrap()

Returns:

the TextWrap status