com.qoppa.pdfEditor.outputpreview

Class NamedColorSpace

java.lang.Object

com.qoppa.pdfEditor.outputpreview.NamedColorSpace

All Implemented Interfaces:

Comparable<NamedColorSpace>

public class NamedColorSpace
extends Object
implements Comparable<NamedColorSpace>

This is a wrapper for a ColorSpace. It adds a human readable name that can be referenced from the OutputPreviewOptions.

Author:

Qoppa Software

Constructor Summary

Constructors

Constructor and Description
NamedColorSpace(ColorSpace cs, String name, boolean userColorSpace) Create a new NamedColorSpace.
NamedColorSpace(File iccProfile, boolean userColorSpace) Create a new NamedColorSpace from an ICC Profile.
NamedColorSpace(InputStream iccProfile, boolean userColorSpace, String defaultName) Create a new NamedColorSpace from an ICC Profile.

Method Summary

Modifier and Type	Method and Description
int	compareTo(NamedColorSpace o) Compares NamedColorSpaces based on their ColorSpace, with RGB coming before CMYK which comes before custom/user color spaces.
ColorSpace	getColorSpace() Gets the ColorSpace.
static String	getDescription(ICC_Profile prof) Gets the description of the ICC Profile from the tagged data in the profile.
String	getName() The human readable name of the color space that will be referenced from OutputPreviewOptions.
boolean	isUserColorSpace() Returns true if this is a user (custom) color space.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NamedColorSpace

public NamedColorSpace(ColorSpace cs,
                       String name,
                       boolean userColorSpace)

Create a new NamedColorSpace.

Parameters:

cs - The ColorSpace.

name - The human readable name of the color space to be referenced from the OutputPreviewOptions.

userColorSpace - Set to true if this is a user (custom) color space.

NamedColorSpace

public NamedColorSpace(File iccProfile,
                       boolean userColorSpace)
                throws FileNotFoundException,
                       IOException

Create a new NamedColorSpace from an ICC Profile.

Parameters:

iccProfile - the ICC Profile file.

userColorSpace - Set to true if this is a user (custom) color space.

Throws:

FileNotFoundException

IOException

NamedColorSpace

public NamedColorSpace(InputStream iccProfile,
                       boolean userColorSpace,
                       String defaultName)
                throws FileNotFoundException,
                       IOException

Create a new NamedColorSpace from an ICC Profile.

Parameters:

iccProfile - the ICC Profile file.

userColorSpace - Set to true if this is a user (custom) color space.

Throws:

FileNotFoundException

IOException

Method Detail

getDescription

public static String getDescription(ICC_Profile prof)

Gets the description of the ICC Profile from the tagged data in the profile.

Parameters:

prof - The ICC Profile

Returns:

The profile description or null if it doesn't exist.

getName

public String getName()

The human readable name of the color space that will be referenced from OutputPreviewOptions.

Returns:

The human readable name of the color space that will be referenced from OutputPreviewOptions.

getColorSpace

public ColorSpace getColorSpace()

Gets the ColorSpace.

Returns:

the ColorSpace.

isUserColorSpace

public boolean isUserColorSpace()

Returns true if this is a user (custom) color space.

Returns:

true if this is a user (custom) color space.

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(NamedColorSpace o)

Compares NamedColorSpaces based on their ColorSpace, with RGB coming before CMYK which comes before custom/user color spaces.

Specified by:

compareTo in interface Comparable<NamedColorSpace>