Packages

com.groupdocs.metadata.core

Interfaces

Classes

Exceptions

java.lang.Object
- com.groupdocs.metadata.core.MetadataPackage
- - com.groupdocs.metadata.core.CustomPackage
  - - com.groupdocs.metadata.core.XmpMetadataContainer
    - - com.groupdocs.metadata.core.XmpComplexType
      - com.groupdocs.metadata.core.XmpColorantBase

All Implemented Interfaces:

IXmpType, Iterable<MetadataProperty>

Direct Known Subclasses:

XmpColorantCmyk, XmpColorantLab, XmpColorantRgb
```
public class XmpColorantBase
extends XmpComplexType
```
A structure containing the characteristics of a colorant (swatch) used in a document.

Method Summary

Methods
Modifier and Type	Method and Description
`Integer`	`getColorType()` Gets the type of color.
`int`	`getMode()` Gets the colour space in which the colour is defined.
`String`	`getSwatchName()` Gets the name of the swatch.
`void`	`setColorType(Integer value)` Sets the type of color.
`void`	`setSwatchName(String value)` Sets the name of the swatch.

Methods inherited from class com.groupdocs.metadata.core.XmpComplexType
getNamespaceUri, getNamespaceUris, getPrefixes, getXmpRepresentation, toString

Methods inherited from class com.groupdocs.metadata.core.MetadataPackage
addProperties, contains, findProperties, get_Item, getCount, getKeys, getKnowPropertyDescriptors, getMetadataType, getPropertyDescriptors, iterator, removeProperties, sanitize, setProperties, updateProperties

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

- Method Detail
  - getMode
```
public final int getMode()
```
    Gets the colour space in which the colour is defined. One of: CMYK, RGB, LAB.
    
    Returns:
    The color mode.
  - getSwatchName
```
public final String getSwatchName()
```
    Gets the name of the swatch.
    
    Returns:
    The name of the swatch.
  - setSwatchName
```
public final void setSwatchName(String value)
```
    Sets the name of the swatch.
    
    Parameters:
    value - The name of the swatch.
  - getColorType
```
public final Integer getColorType()
```
    Gets the type of color.
    
    Returns:
    The color type.
  - setColorType
```
public final void setColorType(Integer value)
```
    Sets the type of color.
    
    Parameters:
    value - The color type.