com.supermap.data

类 Colors

java.lang.Object

com.supermap.data.InternalHandle

com.supermap.data.InternalHandleDisposable

com.supermap.data.Colors

所有已实现的接口:

IDisposable

public class Colors
extends com.supermap.data.InternalHandleDisposable

颜色集合类。

该类主要作用是提供颜色序列。提供各种渐变色和随机色的生成，以及 SuperMap 预定义渐变色的生成。

颜色集合类可用于各个专题图对象如：单值专题图、 分段专题图、 统计专题图、 等级符号专题图、 标签专题图、 点密度专题图及各个空间对象（比如Geometry 类）中颜色属性的设置。

构造器概要

构造器

构造器和说明
Colors() 构造一个新的 Colors 对象。
Colors(Color[] colors) 根据指定的参数来构造一个 Colors 的新对象。
Colors(Colors colors) 根据给定的 Colors 对象构造一个与其完全相同的新对象。

方法概要

限定符和类型	方法和说明
int	add(Color color) 将指定的颜色值对象添加到当前的颜色集合对象中，该对象将置于集合的末尾。
int	addRange(Color[] colors) 将颜色集合数组添加到当前颜色集合对象中。
void	clear() 删除所有的颜色元素。
void	dispose() 释放该对象所占用的资源。
Color	get(int index) 返回颜色集合中指定序号的颜色值。
int	getCount() 返回颜色集合中颜色的个数。
boolean	insert(int index, Color color) 在颜色集合中指定的位置插入指定的颜色对象。
static Colors	makeGradient(int count, Color[] gradientColors) 根据给定颜色的数量和控制颜色生成一组渐变色。
static Colors	makeGradient(int count, ColorGradientType type, boolean reverse) 此方法用于生成系统预定义渐变色。
static Colors	makeRandom(int count) 用于生成一定数量的随机颜色。
Colors	makeRandom(int count, Color[] color) 用于生成一定数量的随机颜色。
boolean	remove(int index) 从指定序号处开始移除颜色元素。
void	set(int index, Color value) 设置颜色集合中指定序号的颜色值。
Color[]	toArray() 将当前颜色集合对象转换为一个颜色对象数组。
String	toString() 返回一个表示该颜色集合的字符串，格式为 {Count=}。

从类继承的方法 com.supermap.data.InternalHandleDisposable

makeSureNativeObjectLive

从类继承的方法 java.lang.Object

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

构造器详细资料

Colors

public Colors()

构造一个新的 Colors 对象。

Colors

public Colors(Color[] colors)

根据指定的参数来构造一个 Colors 的新对象。

参数:

colors - 指定的颜色列表。

Colors

public Colors(Colors colors)

根据给定的 Colors 对象构造一个与其完全相同的新对象。

参数:

colors - 给定的 Colors 对象。

方法详细资料

get

public Color get(int index)

返回颜色集合中指定序号的颜色值。

参数:

index - 指定的颜色值的序号（从0开始）。

返回:

颜色集合中指定序号的颜色值。

set

public void set(int index,
                Color value)

设置颜色集合中指定序号的颜色值。

参数:

index - 指定的颜色值的序号（从0开始）。

value - 颜色值。

示范代码:

以下代码示范如何设置颜色集合中指定序号的颜色值。

 public void setTest() {
        // 将序号为1的颜色设置为黑色
        Colors colors = new Colors();
        colors.set(1, new Color(0,0,0));
    }
 

getCount

public int getCount()

返回颜色集合中颜色的个数。

返回:

颜色集合中颜色的个数。

默认值:

默认值为 0。

add

public int add(Color color)

将指定的颜色值对象添加到当前的颜色集合对象中，该对象将置于集合的末尾。

参数:

color - 新增的颜色值对象。

返回:

新增的颜色元素在集合中的序号。

示范代码:

以下代码示范如何将颜色添加到颜色集合中。

  public void addTest() {
        // 定义蓝色，将蓝色添加到当前颜色集合中
        Color color = new Color(0, 0, 255);
        Colors colors = new Colors();
        colors.add(color);
    }
     

addRange

public int addRange(Color[] colors)

将颜色集合数组添加到当前颜色集合对象中。

参数:

colors - 要添加到此颜色集合对象实例的颜色集合数组。

返回:

添加的个数。

示范代码:

以下代码示范如何将颜色数组添加到颜色集合中。

 public void addRangeTest() {
        // 定义颜色数组
        Color colorRed = new Color(255, 0, 0);
        Color colorGreen = new Color(0, 255, 0);
        Color colorBlue = new Color(0, 0, 255);
        Color[] colorArray = {colorRed, colorGreen, colorBlue};

        // 将颜色数组添加到当前颜色集合中
        Colors colors = new Colors();
        colors.addRange(colorArray);
    }
 

insert

public boolean insert(int index,
                      Color color)

在颜色集合中指定的位置插入指定的颜色对象。

参数:

index - 指定的插入位置在集合中的序号。

color - 指定的待插入的颜色对象。

返回:

如果插入成功，返回 true，否则返回 false。

示范代码:

以下代码示范如何将一种颜色插入到指定位置处。

 public void insertTest() {
        // 实例化一个颜色集合
        Color[] colorArray = {new Color(255, 100, 0), new Color(0, 255, 0),
                             new Color(0, 0, 255)};
        Colors colors = new Colors(colorArray);

        // 定义待插入的颜色（红色）
        Color colorRed = new Color(255, 0, 0);

        // 将红色插入到指定位置处（插入后为倒数第二个颜色）
        int count = colors.getCount();
        colors.insert(count - 1, colorRed);
    }
 

remove

public boolean remove(int index)

从指定序号处开始移除颜色元素。

参数:

index - 指定的颜色集合的序号。

返回:

如果删除成功返回 true，否则返回 false。

另请参阅:

Colors.clear()

clear

public void clear()

删除所有的颜色元素。

makeRandom

public static Colors makeRandom(int count)

用于生成一定数量的随机颜色。

参数:

count - 要生成的随机颜色的数量。

返回:

一个随机颜色类型。

示范代码:

  public Colors makeRandomTest() {
        // Make random colors according to the specifed count.
        // 生成指定数量的随机颜色
        Colors colors = Colors.makeRandom(10);
        return colors;
        ==============================
        运行结果是根据随机生成的10个颜色。
    }
 

makeGradient

public static Colors makeGradient(int count,
                                  Color[] gradientColors)

根据给定颜色的数量和控制颜色生成一组渐变色。

参数:

count - 用户给定的生成渐变色的颜色总数。其中用户可以设定不同颜色之间渐变的中间颜色的个数。

gradientColors - 渐变颜色集。即生成渐变色的控制颜色。

返回:

一个随机颜色实例。

makeGradient

public static Colors makeGradient(int count,
                                  ColorGradientType type,
                                  boolean reverse)

此方法用于生成系统预定义渐变色。

参数:

count - 要生成的渐变色的颜色总数。

type - 渐变颜色的类型。

reverse - 是否反向生成渐变色，即是否从终止色到起始色生成渐变色。

返回:

一个颜色集合类的渐变颜色对象。

另请参阅:

ColorGradientType

示范代码:

以下代码示范如何根据给定颜色的数量和系统预定义渐变色生成一组渐变色。

 public void makeGradientTest() {
        // 根据指定的渐变颜色类型，返回一个 Colors 类的对象
        Colors colors = Colors.makeGradient(4, ColorGradientType.CYANGREEN, false);

        ========================================
        运行结果是根据指定的渐变颜色返回的4个颜色:
        java.awt.Color[r=0,g=255,b=0],
        java.awt.Color[r=0,g=255,b=85],
        java.awt.Color[r=0,g=255,b=170],
        java.awt.Color[r=0,g=255,b=255]

    }
 

toArray

public Color[] toArray()

将当前颜色集合对象转换为一个颜色对象数组。

返回:

当前颜色集合对象转换成的一个颜色对象数组。

toString

public String toString()

返回一个表示该颜色集合的字符串，格式为 {Count=}。

覆盖:

toString 在类中 Object

返回:

一个表示该颜色集合类的字符串。

dispose

public void dispose()

释放该对象所占用的资源。当调用该方法之后，此对象不再可用。

makeRandom

public Colors makeRandom(int count,
                         Color[] color)

用于生成一定数量的随机颜色。

参数:

count - 间隔色个数。

color - 控制色集合。

返回:

由间隔色个数和控制色集合生成的随机颜色表。