Font.Weight (aXSL API)

java.lang.Object
- java.lang.Enum<Font.Weight>
- - org.axsl.font.Font.Weight

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Font.Weight>

Enclosing interface:

Font
```
public static enum Font.Weight
extends java.lang.Enum<Font.Weight>
```
Enumeration of constants needed to describe the weight of a font.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ANY` Font-weight constant indicating no preference.
`BLACK` Font-weight constant indicating a weight of 900 (black).
`BOLD` Font-weight constant indicating a weight of 700 (bold).
`DARK` Font-weight constant indicating a weight of 500 (dark).
`EXTRA_BOLD` Font-weight constant indicating a weight of 800 (extra bold).
`EXTREMELY_LIGHT` Font-weight constant indicating a weight of 100 (extremely light).
`LIGHT` Font-weight constant indicating a weight of 300 (light).
`NORMAL` Font-weight constant indicating a weight of 400 (normal).
`SEMI_BOLD` Font-weight constant indicating a weight of 600 (semi-bold).
`VERY_LIGHT` Font-weight constant indicating a weight of 200 (very light).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Font.Weight`	`fromNumeric(int numericWeight)` Returns the Weight constant corresponding to a given numeric weight.
`java.lang.String`	`getCssValue()` Returns the String describing this weight in CSS.
`java.lang.String`	`getFoValue()` Returns the String describing this weight in XSL-FO.
`short`	`getNumericWeight()` Return this weight's numeric weight.
`static boolean`	`isValidNumericWeight(int numericWeight)` Indicates whether a given numeric weight has a corresponding Weight instance.
`Font.Weight`	`nextHeaviest()` Returns the next heaviest weight.
`Font.Weight`	`nextLightest()` Returns the next lightest weight.
`static Font.Weight`	`parseCss(java.lang.String input, boolean lowerCaseOnly)` Parses a CSS2 String into an instance of `Font.Weight`.
`static Font.Weight`	`parseFo(java.lang.String input, boolean lowerCaseOnly)` Parses an XSL-FO String into an instance of `Font.Weight`.
`static Font.Weight`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static Font.Weight[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - ANY
```
public static final Font.Weight ANY
```
    Font-weight constant indicating no preference.
  - EXTREMELY_LIGHT
```
public static final Font.Weight EXTREMELY_LIGHT
```
    Font-weight constant indicating a weight of 100 (extremely light).
  - VERY_LIGHT
```
public static final Font.Weight VERY_LIGHT
```
    Font-weight constant indicating a weight of 200 (very light).
  - LIGHT
```
public static final Font.Weight LIGHT
```
    Font-weight constant indicating a weight of 300 (light).
  - NORMAL
```
public static final Font.Weight NORMAL
```
    Font-weight constant indicating a weight of 400 (normal).
  - DARK
```
public static final Font.Weight DARK
```
    Font-weight constant indicating a weight of 500 (dark).
  - SEMI_BOLD
```
public static final Font.Weight SEMI_BOLD
```
    Font-weight constant indicating a weight of 600 (semi-bold).
  - BOLD
```
public static final Font.Weight BOLD
```
    Font-weight constant indicating a weight of 700 (bold).
  - EXTRA_BOLD
```
public static final Font.Weight EXTRA_BOLD
```
    Font-weight constant indicating a weight of 800 (extra bold).
  - BLACK
```
public static final Font.Weight BLACK
```
    Font-weight constant indicating a weight of 900 (black).
- Method Detail
  - values
```
public static Font.Weight[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Font.Weight c : Font.Weight.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Font.Weight valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getNumericWeight
```
public short getNumericWeight()
```
    Return this weight's numeric weight. This is useful for mathematical comparisons of the relative weights.
    
    Returns:
    
    This weight's numeric weight. Valid values range from 100 to 900. Invalid values return Short.MIN_VALUE.
  - getCssValue
```
public java.lang.String getCssValue()
```
    Returns the String describing this weight in CSS.
    
    Returns:
    
    The String describing this weight in CSS.
  - getFoValue
```
public java.lang.String getFoValue()
```
    Returns the String describing this weight in XSL-FO.
    
    Returns:
    
    The String describing this weight in XSL-FO.
  - nextHeaviest
```
public Font.Weight nextHeaviest()
```
    Returns the next heaviest weight.
    
    Returns:
    
    The next heaviest weight, null if this is not a valid weight, or if this is the heaviest weight, returns itself.
  - nextLightest
```
public Font.Weight nextLightest()
```
    Returns the next lightest weight.
    
    Returns:
    
    The next lightest weight, null if this is not a valid weight, or if this is the lightest weight, returns itself.
  - fromNumeric
```
public static Font.Weight fromNumeric(int numericWeight)
```
    Returns the Weight constant corresponding to a given numeric weight.
    
    Parameters:
    
    numericWeight - The numeric weight for which a constant is needed. This should be 100, 200, 300, 400, 500, 600, 700, 800, or 900.
    
    Returns:
    
    The Weight instance, or null if none corresponds to numericWeight.
  - isValidNumericWeight
```
public static boolean isValidNumericWeight(int numericWeight)
```
    Indicates whether a given numeric weight has a corresponding Weight instance.
    
    Parameters:
    
    numericWeight - The numeric weight being tested.
    
    Returns:
    
    True iff there is a Weight instance corresponding to numericWeight
  - parseCss
```
public static Font.Weight parseCss(java.lang.String input,
                                   boolean lowerCaseOnly)
```
    Parses a CSS2 String into an instance of Font.Weight.
    
    Parameters:
    
    input - The CSS2-style String to be converted.
    
    lowerCaseOnly - Set to true to insist that all input values be lowercase. There is some ambiguity about whether CSS is case-sensitive or not. If it is, all input should be lower case.
    
    Returns:
    
    An instance of Font.Weight, or null if the input is not valid.
  - parseFo
```
public static Font.Weight parseFo(java.lang.String input,
                                  boolean lowerCaseOnly)
```
    Parses an XSL-FO String into an instance of Font.Weight.
    
    Parameters:
    
    input - The XSL-FO-style String to be converted.
    
    lowerCaseOnly - Set to true to insist that all input values be lowercase. There is some ambiguity about whether XSL-FO is case-sensitive or not. If it is, all input should be lower case.
    
    Returns:
    
    An instance of Font.Weight, or null if the input is not valid.

This documentation was created 2017-01-24 at 21:26 GMT by The aXSL Group and may be freely copied. See license for details.

Enum Font.Weight

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

ANY

EXTREMELY_LIGHT

VERY_LIGHT

LIGHT

NORMAL

DARK

SEMI_BOLD

BOLD

EXTRA_BOLD

BLACK

Method Detail

values

valueOf

getNumericWeight

getCssValue

getFoValue

nextHeaviest

nextLightest

fromNumeric

isValidNumericWeight

parseCss

parseFo