Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.poi.hssf.record.common
Class ExtendedColor

    java.lang.Object
      org.apache.poi.hssf.record.common.ExtendedColor

All Implemented Interfaces:
  java.lang.Cloneable

    public final class ExtendedColor

extends java.lang.Object
implements java.lang.Cloneable

Title: CTColor (Extended Color) record part

The HSSF file format normally stores Color information in the Palette (see PaletteRecord), but for a few cases (eg Conditional Formatting, Sheet Extensions), this XSSF-style color record can be used.

Field Summary
`static int` | `THEME_ACCENT_1`
`static int` | `THEME_ACCENT_2`
`static int` | `THEME_ACCENT_3`
`static int` | `THEME_ACCENT_4`
`static int` | `THEME_ACCENT_5`
`static int` | `THEME_ACCENT_6`
`static int` | `THEME_DARK_1`
`static int` | `THEME_DARK_2`
`static int` | `THEME_FOLLOWED_HYPERLINK`
`static int` | `THEME_HYPERLINK`
`static int` | `THEME_LIGHT_1`
`static int` | `THEME_LIGHT_2`
`static int` | `TYPE_AUTO`
`static int` | `TYPE_INDEXED`
`static int` | `TYPE_RGB`
`static int` | `TYPE_THEMED`
`static int` | `TYPE_UNSET`

Constructor Summary
`ExtendedColor()`
`ExtendedColor(LittleEndianInput in)`

Method Summary
`ExtendedColor` | `clone()`
`int` | `getColorIndex()`
`int` | `getDataLength()`
`byte[]` | `getRGBA()`
`int` | `getThemeIndex()`
`double` | `getTint()`
`int` | `getType()`
`void` | `serialize(LittleEndianOutput out)`
`void` | `setColorIndex(int colorIndex)`
`void` | `setRGBA(byte[] rgba)`
`void` | `setThemeIndex(int themeIndex)`
`void` | `setTint(double tint)`
`void` | `setType(int type)`
`java.lang.String` | `toString()`

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### TYPE_AUTO

    public static final int TYPE_AUTO

See Also:
  Constant Field Values

### TYPE_INDEXED

    public static final int TYPE_INDEXED

See Also:
  Constant Field Values

### TYPE_RGB

    public static final int TYPE_RGB

See Also:
  Constant Field Values

### TYPE_THEMED

    public static final int TYPE_THEMED

See Also:
  Constant Field Values

### TYPE_UNSET

    public static final int TYPE_UNSET

See Also:
  Constant Field Values

### THEME_DARK_1

    public static final int THEME_DARK_1

See Also:
  Constant Field Values

### THEME_LIGHT_1

    public static final int THEME_LIGHT_1

See Also:
  Constant Field Values

### THEME_DARK_2

    public static final int THEME_DARK_2

See Also:
  Constant Field Values

### THEME_LIGHT_2

    public static final int THEME_LIGHT_2

See Also:
  Constant Field Values

### THEME_ACCENT_1

    public static final int THEME_ACCENT_1

See Also:
  Constant Field Values

### THEME_ACCENT_2

    public static final int THEME_ACCENT_2

See Also:
  Constant Field Values

### THEME_ACCENT_3

    public static final int THEME_ACCENT_3

See Also:
  Constant Field Values

### THEME_ACCENT_4

    public static final int THEME_ACCENT_4

See Also:
  Constant Field Values

### THEME_ACCENT_5

    public static final int THEME_ACCENT_5

See Also:
  Constant Field Values

### THEME_ACCENT_6

    public static final int THEME_ACCENT_6

See Also:
  Constant Field Values

### THEME_HYPERLINK

    public static final int THEME_HYPERLINK

See Also:
  Constant Field Values

### THEME_FOLLOWED_HYPERLINK

    public static final int THEME_FOLLOWED_HYPERLINK

See Also:
  Constant Field Values

Constructor Detail

### ExtendedColor

    public ExtendedColor()

### ExtendedColor

    public ExtendedColor(LittleEndianInput in)

Method Detail

### getType

    public int getType()

### setType

    public void setType(int type)

### getColorIndex

    public int getColorIndex()

  Returns:
    Palette color index, if type is `TYPE_INDEXED`

### setColorIndex

    public void setColorIndex(int colorIndex)

### getRGBA

    public byte[] getRGBA()

  Returns:
    Red Green Blue Alpha, if type is `TYPE_RGB`

### setRGBA

    public void setRGBA(byte[] rgba)

### getThemeIndex

    public int getThemeIndex()

  Returns:
    Theme color type index, eg `THEME_DARK_1`, if type is `TYPE_THEMED`

### setThemeIndex

    public void setThemeIndex(int themeIndex)

### getTint

    public double getTint()

  Returns:
    Tint and Shade value, between -1 and +1

### setTint

    public void setTint(double tint)

  Parameters:
    `tint` - Tint and Shade value, between -1 and +1

### toString

    public java.lang.String toString()

  Overrides:
    `toString` in class `java.lang.Object`

### clone

    public ExtendedColor clone()

  Overrides:
    `clone` in class `java.lang.Object`

### getDataLength

    public int getDataLength()

### serialize

    public void serialize(LittleEndianOutput out)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright 2017 The Apache Software Foundation or its licensors, as applicable.