Package com.smartsheet.api.models.format
Class Format
- java.lang.Object
-
- com.smartsheet.api.models.format.Format
-
public class Format extends java.lang.ObjectThis class represents the format as applied to a cell, row or column.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFormat.FormatBuilderBuilder class for a Format objectstatic classFormat.FormatSerializer
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ColorgetBackgroundColor()BoldgetBold()CurrencygetCurrency()DateFormatgetDateFormat()DecimalCountgetDecimalCount()FontFamilygetFontFamily()FontSizegetFontSize()protected <T extends java.lang.Enum<?>>
TgetFormatValue(com.smartsheet.api.models.format.Format.FormatAttribute attribute, T[] values)HorizontalAlignmentgetHorizontalAlignment()ItalicgetItalic()NumberFormatgetNumberFormat()StrikethroughgetStrikethrough()ColorgetTaskbarColor()ColorgetTextColor()TextWrapgetTextWrap()ThousandsSeparatorgetThousandsSeparator()UnderlinegetUnderline()VerticalAlignmentgetVerticalAlignment()
-
-
-
Constructor Detail
-
Format
public Format(java.lang.String original)
Constructs aFormatobject 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 aFormatobject 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
Strikethroughstatus
-
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
DateFormatstatus
-
-