public class Palette extends Object implements Comparable<Palette>
Modifier and Type | Field and Description |
---|---|
private Color[] |
colors |
private String |
description |
private ColorGradient |
gradient |
private boolean |
hidden |
private String |
name |
private int |
numberOfGradientColours |
private String |
paletteGroup |
private boolean |
reversed |
private String |
shortName |
Constructor and Description |
---|
Palette() |
Palette(String name,
String shortName,
ColorGradient gradient,
int numberOfGradientColours)
Same as
Palette(String, String, String, ColorGradient, int) , using the name as description field |
Palette(String name,
String shortName,
String description,
Color[] colors) |
Palette(String name,
String shortName,
String description,
ColorGradient gradient,
int numberOfGradientColours) |
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Palette other)
Compares palette objects by name.
|
void |
deleteColor(int pos) |
String |
getCacheKey() |
Color |
getColor(int index) |
Color |
getColorConstrained(int index) |
Color[] |
getColors() |
String |
getDescription() |
ColorGradient |
getGradient() |
String |
getLongDescription() |
String |
getName() |
int |
getNumberOfColours() |
int |
getNumberOfGradientColours() |
org.jdom.Element |
getPaletteAsXML() |
String |
getPaletteGroup() |
String |
getShortName() |
void |
insertColor(int pos,
Color c) |
boolean |
isHidden()
Returns true if the palette should not be shown in the Palettes menu.
|
boolean |
isReversed() |
private static Palette |
loadPaletteFromXML_v1x0(org.jdom.Element root) |
private static Palette |
loadPaletteFromXML(org.jdom.Document doc) |
static Palette |
loadPaletteFromXML(File file) |
static Palette |
loadPaletteFromXML(InputStream in) |
static Palette |
loadPaletteFromXML(JarFile jarFile,
String name) |
double |
maxColourIndex() |
void |
reverse() |
Color[] |
reverseColors() |
void |
savePaletteAsJavaCode(File file)
Save the Palette as Javacode to the given file.
|
void |
savePaletteToMatlab(File file)
Save the Palette as Matlab code to the given file.
|
void |
savePaletteToXML(File file) |
void |
setColor(int index,
Color c) |
void |
setDescription(String description) |
void |
setGradient(ColorGradient gradient) |
private void |
setGradient(ColorGradient gradient,
int numberOfGradientColours) |
void |
setHidden(boolean hidden) |
void |
setName(String name) |
void |
setNumberOfGradientColours(int numberOfGradientColours)
Sets the number of gradient colours to be used, and generates the palette colours (
colors ) new. |
void |
setPaletteGroup(String paletteGroup) |
void |
setShortName(String shortName) |
String |
toString() |
private String name
private String description
private String paletteGroup
private Color[] colors
private ColorGradient gradient
private int numberOfGradientColours
private String shortName
private boolean hidden
private boolean reversed
public Palette()
public Palette(String name, String shortName, String description, ColorGradient gradient, int numberOfGradientColours)
public Palette(String name, String shortName, ColorGradient gradient, int numberOfGradientColours)
Palette(String, String, String, ColorGradient, int)
, using the name as description fieldpublic String getPaletteGroup()
public void setPaletteGroup(String paletteGroup)
public void deleteColor(int pos)
public void insertColor(int pos, Color c)
public Color[] getColors()
public Color getColor(int index)
public Color getColorConstrained(int index)
public String getDescription()
public String getName()
public String getShortName()
public int compareTo(Palette other)
compareTo
in interface Comparable<Palette>
public String getCacheKey()
public String getLongDescription()
public int getNumberOfGradientColours()
public ColorGradient getGradient()
public void setColor(int index, Color c)
public void setGradient(ColorGradient gradient)
private void setGradient(ColorGradient gradient, int numberOfGradientColours)
public void setNumberOfGradientColours(int numberOfGradientColours)
colors
) new.public static Palette loadPaletteFromXML(InputStream in) throws org.jdom.JDOMException, IOException
org.jdom.JDOMException
IOException
public static Palette loadPaletteFromXML(File file) throws SOMToolboxException
SOMToolboxException
public static Palette loadPaletteFromXML(JarFile jarFile, String name) throws SOMToolboxException
SOMToolboxException
private static Palette loadPaletteFromXML(org.jdom.Document doc) throws org.jdom.JDOMException
org.jdom.JDOMException
private static Palette loadPaletteFromXML_v1x0(org.jdom.Element root)
public void savePaletteToMatlab(File file)
file
- The file to save to or public void savePaletteAsJavaCode(File file)
file
- The file to save to or public void savePaletteToXML(File file)
public org.jdom.Element getPaletteAsXML()
<palette>...</palette>
public void setDescription(String description)
public void setName(String name)
public void setShortName(String shortName)
public void reverse()
public boolean isReversed()
public Color[] reverseColors()
public int getNumberOfColours()
public double maxColourIndex()
public boolean isHidden()
true
iff the palette is secret.public void setHidden(boolean hidden)