TextStyle
class TextStyle
| kotlin.Any | ||
| ↳ | kotlin.Enum<java.time.format.TextStyle> | |
| ↳ | java.time.format.TextStyle | |
Enumeration of the style of text formatting and parsing.
Text styles define three sizes for the formatted text - 'full', 'short' and 'narrow'. Each of these three sizes is available in both 'standard' and 'stand-alone' variations.
The difference between the three sizes is obvious in most languages. For example, in English the 'full' month is 'January', the 'short' month is 'Jan' and the 'narrow' month is 'J'. Note that the narrow size is often not unique. For example, 'January', 'June' and 'July' all have the 'narrow' text 'J'.
The difference between the 'standard' and 'stand-alone' forms is trickier to describe as there is no difference in English. However, in other languages there is a difference in the word used when the text is used alone, as opposed to in a complete date. For example, the word used for a month when used alone in a date picker is different to the word used for month in association with a day and year in a date.
Summary
| Enum values | |
|---|---|
|
Full text, typically the full description. |
|
|
Full text for stand-alone use, typically the full description. |
|
|
Narrow text, typically a single letter. |
|
|
Narrow text for stand-alone use, typically a single letter. |
|
|
Short text, typically an abbreviation. |
|
|
Short text for stand-alone use, typically an abbreviation. |
|
| Public methods | |
|---|---|
| TextStyle! |
asNormal()Returns the normal style with the same size. |
| TextStyle! |
Returns the stand-alone style with the same size. |
| Boolean |
Returns true if the Style is a stand-alone style. |
Enum values
FULL
enum val FULL : TextStyle
Full text, typically the full description. For example, day-of-week Monday might output "Monday".
FULL_STANDALONE
enum val FULL_STANDALONE : TextStyle
Full text for stand-alone use, typically the full description. For example, day-of-week Monday might output "Monday".
NARROW
enum val NARROW : TextStyle
Narrow text, typically a single letter. For example, day-of-week Monday might output "M".
NARROW_STANDALONE
enum val NARROW_STANDALONE : TextStyle
Narrow text for stand-alone use, typically a single letter. For example, day-of-week Monday might output "M".
SHORT
enum val SHORT : TextStyle
Short text, typically an abbreviation. For example, day-of-week Monday might output "Mon".
SHORT_STANDALONE
enum val SHORT_STANDALONE : TextStyle
Short text for stand-alone use, typically an abbreviation. For example, day-of-week Monday might output "Mon".
Public methods
asNormal
fun asNormal(): TextStyle!
Returns the normal style with the same size.
| Return | |
|---|---|
TextStyle! |
the normal style with the same size |
asStandalone
fun asStandalone(): TextStyle!
Returns the stand-alone style with the same size.
| Return | |
|---|---|
TextStyle! |
the stand-alone style with the same size |
isStandalone
fun isStandalone(): Boolean
Returns true if the Style is a stand-alone style.
| Return | |
|---|---|
Boolean |
true if the style is a stand-alone style. |