Package com.smartsheet.api.models.format
Class Format
- java.lang.Object
-
- com.smartsheet.api.models.format.Format
-
public class Format extends java.lang.Object
This class represents the format as applied to a cell, row or column.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Format.FormatBuilder
Builder class for a Format objectstatic class
Format.FormatSerializer
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Color
getBackgroundColor()
Bold
getBold()
Currency
getCurrency()
DateFormat
getDateFormat()
DecimalCount
getDecimalCount()
FontFamily
getFontFamily()
FontSize
getFontSize()
protected <T extends java.lang.Enum<?>>
TgetFormatValue(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()
-
-
-
Constructor Detail
-
Format
public Format(java.lang.String original)
Constructs aFormat
object using the format string provided by the Smartsheet API.The format of the string is a comma separated list. See https://smartsheet.redoc.ly/#section/API-Basics/Formatting for details
- Parameters:
original
- the original
-
Format
public Format()
Creates aFormat
object with default values.
-
-
Method Detail
-
getFormatValue
protected <T extends java.lang.Enum<?>> T getFormatValue(com.smartsheet.api.models.format.Format.FormatAttribute attribute, T[] values)
-
getFontFamily
public FontFamily getFontFamily()
- Returns:
- the
FontFamily
.
-
getStrikethrough
public Strikethrough getStrikethrough()
- Returns:
- the
Strikethrough
status
-
getHorizontalAlignment
public HorizontalAlignment getHorizontalAlignment()
- Returns:
- the
HorizontalAlignment
-
getVerticalAlignment
public VerticalAlignment getVerticalAlignment()
- Returns:
- the
VerticalAlignment
-
getDecimalCount
public DecimalCount getDecimalCount()
- Returns:
- the
DecimalCount
-
getThousandsSeparator
public ThousandsSeparator getThousandsSeparator()
- Returns:
- the
ThousandsSeparator
-
getNumberFormat
public NumberFormat getNumberFormat()
- Returns:
- the
NumberFormat
-
getDateFormat
public DateFormat getDateFormat()
- Returns:
- the
DateFormat
status
-
-