com.ijchart.xychart.shape
Interface IChartShape

All Known Implementing Classes:
AbstractChartShape, AbstractImageChartShape, AbstractRectangleTextChartShape, AbstractTextChartShape, BoxAndWhiskerChartShape, CylinderTextChartShape, DblHeadMatchstickChartShape, DualBreakLineChartShape, EllipseTextChartShape, ErrorCrossChartShape, GeneralPathChartShape, GranttChartShape, HighLowChartShape, IShapedChartShape, LegendItemChartShape, LineAndShapeChartShape, LineChartShape, MeterArcChartShape, MinMaxChartShape, PaintScaleLegendChartShape, ParallelepipedTextChartShape, PieOutsideLabelChartShape, RectangleImageChartShape, RectangleTextChartShape, RingChartShape, SectorChartShape, StatisticalBarChartShape, StatisticalLineChartShape, StockChartShape, TextAndPointerChartShape

public interface IChartShape

Title: IJChart

Description: a chart library for the Java(tm) platform.

描述用于在图表中使用的各种图形的接口,对于图表中的各种图形都看作是一个独立的图形对象

Copyright: Copyright (c) 2013

Company:

Version:
1.0
Author:
zhang feng min,shanghai china. Contract me by email.

Field Summary
static java.awt.Paint DEFAULT_BORDER_PAINT
          缺省轮廓线Paint
static java.awt.Stroke DEFAULT_BORDER_STROKE
          缺省轮廓线Stroke
static java.awt.Paint DEFAULT_CONTENT_PAINT
          内容Paint
static boolean DEFAULT_DRAW_BORDER
          缺省绘制外轮廓线
static float DEFAULT_FILL_ALPHA
          缺省填充背景的alpha值.
static java.awt.Paint DEFAULT_FILL_PAINT
          缺省填充Paint
static boolean DEFAULT_FILL_SHAPE
          缺省填充图形
static GradientPaintTransformType DEFAULT_GRADIENT_PAINT_TRANSFORM_TYPE
          缺省的GradientPaint变换类型.
static RectangleInsets DEFAULT_MARGIN
          缺省补白.
static java.awt.Paint DEFAULT_SELECT_FILL_PAINT
          选中部分的填充颜色.
static float DEFAULT_SELECT_RECT_ALPHA
          选中部分的矩形的Alpha值.
static double DEFAULT_SELECT_RECT_WIDTH
          选中部分的矩形的宽度.
static boolean DEFAULT_SELECTED
          是否被选中的缺省值.
static java.awt.Font DEFAULT_TEXT_FONT
          缺省字体.
static java.lang.String HOTSPOT_TYPE_CIRCLE
          圆形热点图形类型.
static java.lang.String HOTSPOT_TYPE_POLYGON
          多边形热点图形类型.
static java.lang.String HOTSPOT_TYPE_RECTANGLE
          矩形热点图形类型.
 
Method Summary
 void addChangeListener(IChartShapeChangeListener listener)
          注册监听图形IChartShape对象变化的监听者对象.
 boolean contains(double x, double y)
          返回点(x,y)是否包含在图形中.
 boolean contains(java.awt.geom.Point2D point)
          返回点point是否包含在图形中.
 void draw(java.awt.Graphics2D g2)
          在图形设备(如屏幕或打印机)上绘制此图形
 void forceChartShapeChanged()
          如果图形对象的内部被改变,而又不能触发事件,可以通过此方法通知图形对象发生改变.
 java.awt.Paint getBorderPaint()
          返回外轮廓线颜色
 java.awt.Stroke getBorderStroke()
          返回外轮廓线画笔
 java.awt.geom.Rectangle2D getBound()
          返回图形的外边框.
 IChartData getData()
          返回IChartData对象.
 float getFillAlpha()
          返回填充背景的alpha值.
 java.awt.Paint getFillPaint()
          返回图形内部的填充颜色
 GradientPaintTransformType getGradientPaintTransformType()
          返回设置图形内部颜色扩展的类型
 java.lang.String getHotspotPolyCoords(java.awt.Shape clipArea)
          返回形成热点的坐标点.
 java.lang.String getHotspotType()
          返回形成热点的图形类型.
 int getId()
          返回图形的编号.
 java.awt.geom.Point2D getLockPoint()
          返回鼠标点击时锁定图形的点.
 java.awt.Shape getOriginTooltipShape()
          返回原始的tooltip区域图形,此图形没有考虑旋转等因素对图形的影响.
 double getRotate()
          返回图形环境旋转角度,单位为弧度.
 IShapeChange getShapeChange()
          返回IShapeChange对象.
 ChartShapeDrawType getShapeDrawType()
          返回图形在chart中的绘制类型.
 ShapeType getShapeType()
          描述本图形的类型.
 java.awt.Shape getTooltipShape()
          返回tooltip区域图形,此图形需要考虑旋转等因素对图形的影响.
 java.lang.String getTooltipText()
          返回tooltip字符串.
 java.awt.geom.Point2D getTopLeftPoint()
          返回图形左上角的坐标(不考虑图形的旋转).
 java.lang.String getURL()
          返回URL字符串.
 boolean isDrawBorder()
          返回轮廓线是否绘制的标志
 boolean isFillShape()
          返回轮廓线是否绘制的标志
 boolean isSelected()
          返回图形是否被选中.
 boolean isVisible()
          返回图形是否可见.
 void removeAllChangeListener()
          清除所有的图形IChartShape对象变化监听者对象.
 void removeChangeListener(IChartShapeChangeListener listener)
          删除注册的图形IChartShape对象变化监听者对象.
 void setBorderPaint(java.awt.Paint paint)
          设置图形外轮廓线的颜色
 void setBorderStroke(java.awt.Stroke stroke)
          设置图形外轮廓线的画笔
 void setData(IChartData data)
          设置IChartData对象.
 void setDrawBorder(boolean flag)
          是否绘制图形的外轮廓线
 void setFillAlpha(float alpha)
          设置填充背景的alpha值,并向所有监听器发送 ChartShapeChangeEvent事件.
 void setFillPaint(java.awt.Paint paint)
          设置图形内部的填充颜色
 void setFillShape(boolean bFillShape)
          是否填充图形内部
 void setGradientPaintTransformType(GradientPaintTransformType transformType)
          设置图形内部的颜色扩展类型,仅当填充所用Paint为GradientPaint
 void setId(int shapeId)
          设置图形的编号,在一个chart中,图形的ID是唯一且连续的.
 void setOriginTooltipShape(java.awt.Shape shape)
          设置原始的tooltip区域图形.
 void setRotate(double theta)
          设置图形环境旋转角度,单位为弧度.仿射变换可以用下面的矩阵表示:
 void setSelected(boolean flag)
          设置图形是否被选中.
 void setShapeChange(IShapeChange change)
          设置IShapeChange对象.
 void setShapeDrawType(ChartShapeDrawType drawType)
          返回图形在chart中的绘制类型.
 void setTooltipText(java.lang.String tooltip)
          设置tooltip字符串.
 void setURL(java.lang.String url)
          设置URL字符串.
 void setVisible(boolean flag)
          设置图形是否可见.
 void translate(double tx, double ty)
          相对移动本图形,其中X轴方向偏移tx,Y轴方向偏移ty,并向所有监听器发送 ChartShapeChangeEvent事件.

See Also:
Constant Field Values

DEFAULT_FILL_SHAPE

static final boolean DEFAULT_FILL_SHAPE
缺省填充图形

See Also:
Constant Field Values

DEFAULT_FILL_ALPHA

static final float DEFAULT_FILL_ALPHA
缺省填充背景的alpha值.

See Also:
Constant Field Values

DEFAULT_CONTENT_PAINT

static final java.awt.Paint DEFAULT_CONTENT_PAINT
内容Paint


DEFAULT_FILL_PAINT

static final java.awt.Paint DEFAULT_FILL_PAINT
缺省填充Paint


DEFAULT_BORDER_PAINT

static final java.awt.Paint DEFAULT_BORDER_PAINT
缺省轮廓线Paint


DEFAULT_MARGIN

static final RectangleInsets DEFAULT_MARGIN
缺省补白.


DEFAULT_GRADIENT_PAINT_TRANSFORM_TYPE

static final GradientPaintTransformType DEFAULT_GRADIENT_PAINT_TRANSFORM_TYPE
缺省的GradientPaint变换类型.


DEFAULT_BORDER_STROKE

static final java.awt.Stroke DEFAULT_BORDER_STROKE
缺省轮廓线Stroke


DEFAULT_SELECT_RECT_WIDTH

static final double DEFAULT_SELECT_RECT_WIDTH
选中部分的矩形的宽度.

See Also:
Constant Field Values

DEFAULT_SELECT_RECT_ALPHA

static final float DEFAULT_SELECT_RECT_ALPHA
选中部分的矩形的Alpha值.

See Also:
Constant Field Values

DEFAULT_SELECT_FILL_PAINT

static final java.awt.Paint DEFAULT_SELECT_FILL_PAINT
选中部分的填充颜色.


DEFAULT_TEXT_FONT

static final java.awt.Font DEFAULT_TEXT_FONT
缺省字体.


DEFAULT_TOOLTIP_SHAPE_WIDTH

static final double DEFAULT_TOOLTIP_SHAPE_WIDTH
tooltip图形外切正方形的边长.

See Also:
Constant Field Values

DEFAULT_SELECTED

static final boolean DEFAULT_SELECTED
是否被选中的缺省值.

See Also:
Constant Field Values

HOTSPOT_TYPE_CIRCLE

static final java.lang.String HOTSPOT_TYPE_CIRCLE
圆形热点图形类型.

See Also:
Constant Field Values

HOTSPOT_TYPE_POLYGON

static final java.lang.String HOTSPOT_TYPE_POLYGON
多边形热点图形类型.

See Also:
Constant Field Values

HOTSPOT_TYPE_RECTANGLE

static final java.lang.String HOTSPOT_TYPE_RECTANGLE
矩形热点图形类型.

See Also:
Constant Field Values
Method Detail

getId

int getId()
返回图形的编号.

Returns:
int 图形的编号.

setId

void setId(int shapeId)
设置图形的编号,在一个chart中,图形的ID是唯一且连续的.

Parameters:
shapeId - int

isDrawBorder

boolean isDrawBorder()
返回轮廓线是否绘制的标志

Returns:
boolean 是返回true,否则返回false

setDrawBorder

void setDrawBorder(boolean flag)
是否绘制图形的外轮廓线

Parameters:
flag - boolean true绘制外轮廓线,false不绘制轮廓线

getBorderStroke

java.awt.Stroke getBorderStroke()
返回外轮廓线画笔

Returns:
Stroke 外轮廓线画笔

setBorderStroke

void setBorderStroke(java.awt.Stroke stroke)
设置图形外轮廓线的画笔

Parameters:
stroke - Stroke 图形外轮廓线画笔(可为null)

getBorderPaint

java.awt.Paint getBorderPaint()
返回外轮廓线颜色

Returns:
Paint 外轮廓线颜色

setBorderPaint

void setBorderPaint(java.awt.Paint paint)
设置图形外轮廓线的颜色

Parameters:
paint - Paint 图形外轮廓线颜色(可为null)

isFillShape

boolean isFillShape()
返回轮廓线是否绘制的标志

Returns:
boolean 是返回true,否则返回false

setFillShape

void setFillShape(boolean bFillShape)
是否填充图形内部

Parameters:
bFillShape - boolean true填充图形内部,false不填充图形内部

getFillPaint

java.awt.Paint getFillPaint()
返回图形内部的填充颜色

Returns:
Paint 图形内部的填充颜色

setFillPaint

void setFillPaint(java.awt.Paint paint)
设置图形内部的填充颜色

Parameters:
paint - Paint 填充图形内部用的Paint(不可为null)

setFillAlpha

void setFillAlpha(float alpha)
设置填充背景的alpha值,并向所有监听器发送 ChartShapeChangeEvent事件.

Parameters:
alpha - float alpha值,须属于闭区间[0.0,1.0].

getFillAlpha

float getFillAlpha()
返回填充背景的alpha值.

Returns:
float alpha值.

getGradientPaintTransformType

GradientPaintTransformType getGradientPaintTransformType()
返回设置图形内部颜色扩展的类型

Returns:
GradientPaintTransformType

setGradientPaintTransformType

void setGradientPaintTransformType(GradientPaintTransformType transformType)
设置图形内部的颜色扩展类型,仅当填充所用Paint为GradientPaint

Parameters:
transformType - GradientPaintTransformType (null permitted)

getTooltipText

java.lang.String getTooltipText()
返回tooltip字符串.

Returns:
String tooltip字符串 (可为null).

setTooltipText

void setTooltipText(java.lang.String tooltip)
设置tooltip字符串.

Parameters:
tooltip - String tooltip字符串 (可为null).

getURL

java.lang.String getURL()
返回URL字符串.

Returns:
String URL字符串 (可为null).

setURL

void setURL(java.lang.String url)
设置URL字符串.

Parameters:
url - String URL字符串 (可为null).

draw

void draw(java.awt.Graphics2D g2)
在图形设备(如屏幕或打印机)上绘制此图形

Parameters:
g2 - Graphics2D 图形设备(如屏幕或打印机) (不可为null)

contains

boolean contains(double x,
                 double y)
返回点(x,y)是否包含在图形中.

Parameters:
x - double (x坐标位置).
y - double (y坐标位置).
Returns:
boolean 包含该坐标则返回true,否则返回false.

contains

boolean contains(java.awt.geom.Point2D point)
返回点point是否包含在图形中.

Parameters:
point - Point2D 坐标值,例如鼠标坐标.(不可为null).
Returns:
boolean 包含该坐标则返回true,否则返回false.

getShapeType

ShapeType getShapeType()
描述本图形的类型.

Returns:
ShapeType ShapeType类定义的常量 (不可为null).

getRotate

double getRotate()
返回图形环境旋转角度,单位为弧度.

Returns:
double 图形环境旋转角度,单位为弧度.

setRotate

void setRotate(double theta)
设置图形环境旋转角度,单位为弧度.仿射变换可以用下面的矩阵表示:
                [   cos(theta)    -sin(theta)    0   ]
                [   sin(theta)     cos(theta)    0   ]
                [       0              0         1   ]
 

Parameters:
theta - 旋转的角度,单位为弧度.

isSelected

boolean isSelected()
返回图形是否被选中.

Returns:
boolean 布尔值.

setSelected

void setSelected(boolean flag)
设置图形是否被选中.

Parameters:
flag - boolean 布尔值.

getOriginTooltipShape

java.awt.Shape getOriginTooltipShape()
返回原始的tooltip区域图形,此图形没有考虑旋转等因素对图形的影响.

Returns:
Shape 图形 (可为null).

setOriginTooltipShape

void setOriginTooltipShape(java.awt.Shape shape)
设置原始的tooltip区域图形.

Parameters:
shape - Shape 图形 (可为null).

getTooltipShape

java.awt.Shape getTooltipShape()
返回tooltip区域图形,此图形需要考虑旋转等因素对图形的影响.

Returns:
Shape 图形 (可为null).

translate

void translate(double tx,
               double ty)
相对移动本图形,其中X轴方向偏移tx,Y轴方向偏移ty,并向所有监听器发送 ChartShapeChangeEvent事件.

Parameters:
tx - double 沿X轴方向的距离.
ty - double 沿Y轴方向的距离.

getTopLeftPoint

java.awt.geom.Point2D getTopLeftPoint()
返回图形左上角的坐标(不考虑图形的旋转).

Returns:
Point2D 坐标值.

getLockPoint

java.awt.geom.Point2D getLockPoint()
返回鼠标点击时锁定图形的点.

Returns:
Point2D 坐标值.

getData

IChartData getData()
返回IChartData对象.

Returns:
IChartData (可为null).

setData

void setData(IChartData data)
设置IChartData对象.

Parameters:
data - IChartData (可为null).

getBound

java.awt.geom.Rectangle2D getBound()
返回图形的外边框.

Returns:
Rectangle2D 外边框.

addChangeListener

void addChangeListener(IChartShapeChangeListener listener)
注册监听图形IChartShape对象变化的监听者对象.

Parameters:
listener - 注册的监听器对象.

removeChangeListener

void removeChangeListener(IChartShapeChangeListener listener)
删除注册的图形IChartShape对象变化监听者对象.

Parameters:
listener - 要删除的监听者对象

removeAllChangeListener

void removeAllChangeListener()
清除所有的图形IChartShape对象变化监听者对象.


forceChartShapeChanged

void forceChartShapeChanged()
如果图形对象的内部被改变,而又不能触发事件,可以通过此方法通知图形对象发生改变.


getShapeDrawType

ChartShapeDrawType getShapeDrawType()
返回图形在chart中的绘制类型.

Returns:
ChartShapeDrawType (不为null).

setShapeDrawType

void setShapeDrawType(ChartShapeDrawType drawType)
返回图形在chart中的绘制类型.

Parameters:
drawType - ChartShapeDrawType (null not permitted).

isVisible

boolean isVisible()
返回图形是否可见.

Returns:
boolean 布尔值.

setVisible

void setVisible(boolean flag)
设置图形是否可见.

Parameters:
flag - boolean 布尔值.

setShapeChange

void setShapeChange(IShapeChange change)
设置IShapeChange对象.

Parameters:
change - IShapeChange IShapeChange对象 (可为null).

getShapeChange

IShapeChange getShapeChange()
返回IShapeChange对象.

Returns:
IShapeChange IShapeChange对象 (可为null).

getHotspotType

java.lang.String getHotspotType()
返回形成热点的图形类型.

Returns:
String 图形类型,返回值是poly或rect.

getHotspotPolyCoords

java.lang.String getHotspotPolyCoords(java.awt.Shape clipArea)
返回形成热点的坐标点.

Parameters:
clipArea - Shape 图形剪切区域 (可为null).
Returns:
String 热点坐标 (可为null).