com.elegantj.graphx
Class GraphExplanNotes

java.lang.Object
  |
  +--com.elegantj.graphx.GraphExplanNotes

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AreaGraphExplanNotes, BarGraphExplanNotes, BubbleGraphExplanNotes, CandleGraphExplanNotes, DoughnutGraphExplanNotes, LineGraphExplanNotes, PieGraphExplanNotes, RadarGraphExplanNotes

public class GraphExplanNotes

extends java.lang.Object

implements java.io.Serializable

GraphExplanNotes class is used to provide the explanation notes for the graph to the user.

See Also:

Serialized Form

Field Summary

static int	BOX_HEIGHT_DECREMENT Specifies the height decrement value
static int	BOX_STRING_HGAP Specifies the horizontal gap
protected ValueFormat	m_Formatter Specifies the Value formatting Object
protected java.util.Vector	m_GraphFormTable Specifies the Graph form table object
GraphicsEx	m_GraphicsEx Specifies the graphics
protected GraphZAxisDetail	m_GraphZAxisDetail Specifies the Z-Axis (Legends) Detail for Graph
protected int	m_Height
protected int	m_inH
protected int	m_inV
protected java.util.Vector	m_LabelList Specifies the Label list
protected int	m_MaxStrLength Specifies the maximum number of character
protected int	m_NotePosition Specifies Z-Axis Position (LEFT/RIGHT/TOP/BOTTOM)
java.awt.Rectangle	m_OriginalClipRect Specifies the original clipping rectange
protected int	m_Width
protected int	m_ZAxisNameHeight Specifies the Z axis name height in pixel

Constructor Summary

GraphExplanNotes(GraphicsEx inGraphicsEx, java.awt.Rectangle inOriginalClipRect, GraphZAxisDetail inGraphZAxisDetail, int inPosition, int inMaxStrLength)
Creates GraphExplanNotes with specified graphics and clipping rectange

Method Summary

void	draw(GraphicsEx inGraphicsEx, int inH, int inV, int inWidth, int inHeight, java.util.Vector inLabelList, java.util.Vector inGraphFormTable) Draws the explanation notes within specified boundary
void	drawLegend(GraphicsEx inGraphicsEx, int index, java.lang.String inLabel, int inX, int inY, int inWidth, int inHeight, int inFontHeight, java.awt.Color inLabelColor, boolean inBkVisible, java.awt.Color inBkColor) Draw Legend at specified location Sub class should have to override to draw legend as per their requirement
DrillDownDetail	getClickedZAxisLabel(int click_x, int click_y) Returns the DrillDownDetail object where mouse click
java.awt.Color	getColor(int inIndex, java.util.Vector inGraphFormTable) Returns the note color of specified label
java.awt.Color	getColor(java.lang.String inLabel, java.util.Vector inGraphFormTable) Returns the note color of specified label
java.awt.Color	getGradientColor(int inIndex, java.util.Vector inGraphFormTable) Returns the note Gradient color of specified label
java.awt.Color	getGradientColor(java.lang.String inLabel, java.util.Vector inGraphFormTable) Returns the note Gradient color of specified label
int	getLineStyle(int inIndex, java.util.Vector inGraphFormTable) Returns the line style of the specified label
int	getLineStyle(java.lang.String inLabel, java.util.Vector inGraphFormTable) Returns the line style of the specified label
int	getNoteHeight(int inWidth, int inHeight, java.util.Vector inLabelList) Returns the Explaination note height
int	getNoteNameHeight(int inWidth, int inHeight) Returns the Explaination note Name height
int	getNoteWidth(int inWidth, int inHeight, java.util.Vector inLabelList) Returns the Explaination note width
int	getWidth(int inNChars) Returns the width of the specified character

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BOX_STRING_HGAP

public static final int BOX_STRING_HGAP

Specifies the horizontal gap

See Also:

Constant Field Values

BOX_HEIGHT_DECREMENT

public static final int BOX_HEIGHT_DECREMENT

Specifies the height decrement value

See Also:

Constant Field Values

m_GraphicsEx

public transient GraphicsEx m_GraphicsEx

Specifies the graphics

m_OriginalClipRect

public java.awt.Rectangle m_OriginalClipRect

Specifies the original clipping rectange

m_GraphZAxisDetail

protected GraphZAxisDetail m_GraphZAxisDetail

Specifies the Z-Axis (Legends) Detail for Graph

m_NotePosition

protected int m_NotePosition

Specifies Z-Axis Position (LEFT/RIGHT/TOP/BOTTOM)

m_MaxStrLength

protected int m_MaxStrLength

Specifies the maximum number of character

m_ZAxisNameHeight

protected int m_ZAxisNameHeight

Specifies the Z axis name height in pixel

m_LabelList

protected java.util.Vector m_LabelList

Specifies the Label list

m_GraphFormTable

protected java.util.Vector m_GraphFormTable

Specifies the Graph form table object

m_Formatter

protected ValueFormat m_Formatter

Specifies the Value formatting Object

m_inV

protected int m_inV

m_inH

protected int m_inH

m_Height

protected int m_Height

m_Width

protected int m_Width

Constructor Detail

GraphExplanNotes

public GraphExplanNotes(GraphicsEx inGraphicsEx,
                        java.awt.Rectangle inOriginalClipRect,
                        GraphZAxisDetail inGraphZAxisDetail,
                        int inPosition,
                        int inMaxStrLength)

Creates GraphExplanNotes with specified graphics and clipping rectange

Method Detail

draw

public void draw(GraphicsEx inGraphicsEx,
                 int inH,
                 int inV,
                 int inWidth,
                 int inHeight,
                 java.util.Vector inLabelList,
                 java.util.Vector inGraphFormTable)

Draws the explanation notes within specified boundary

drawLegend

public void drawLegend(GraphicsEx inGraphicsEx,
                       int index,
                       java.lang.String inLabel,
                       int inX,
                       int inY,
                       int inWidth,
                       int inHeight,
                       int inFontHeight,
                       java.awt.Color inLabelColor,
                       boolean inBkVisible,
                       java.awt.Color inBkColor)

Draw Legend at specified location Sub class should have to override to draw legend as per their requirement

getWidth

public int getWidth(int inNChars)

Returns the width of the specified character

Returns:

int width in pixel

getColor

public java.awt.Color getColor(java.lang.String inLabel,
                               java.util.Vector inGraphFormTable)

Returns the note color of specified label

Returns:

Color return color

getColor

public java.awt.Color getColor(int inIndex,
                               java.util.Vector inGraphFormTable)

Returns the note color of specified label

Returns:

Color return color

getGradientColor

public java.awt.Color getGradientColor(java.lang.String inLabel,
                                       java.util.Vector inGraphFormTable)

Returns the note Gradient color of specified label

Returns:

Color return color

getGradientColor

public java.awt.Color getGradientColor(int inIndex,
                                       java.util.Vector inGraphFormTable)

Returns the note Gradient color of specified label

Returns:

Color return color

getLineStyle

public int getLineStyle(java.lang.String inLabel,
                        java.util.Vector inGraphFormTable)

Returns the line style of the specified label

Parameters:

inLabel - Label string

inGraphFormTable - Graph form table

Returns:

int Return line style

getLineStyle

public int getLineStyle(int inIndex,
                        java.util.Vector inGraphFormTable)

Returns the line style of the specified label

Parameters:

inGraphFormTable - Graph form table

Returns:

int Return line style

getNoteHeight

public int getNoteHeight(int inWidth,
                         int inHeight,
                         java.util.Vector inLabelList)

Returns the Explaination note height

Parameters:

inWidth - Width

inHeight - Height

inLabelList - Label list

Returns:

int Return Explaination note height

getNoteWidth

public int getNoteWidth(int inWidth,
                        int inHeight,
                        java.util.Vector inLabelList)

Returns the Explaination note width

Parameters:

inWidth - Width

inHeight - Height

inLabelList - Label list

Returns:

int Return Explaination note width

getNoteNameHeight

public int getNoteNameHeight(int inWidth,
                             int inHeight)

Returns the Explaination note Name height

Parameters:

inWidth - Width

inHeight - Height

Returns:

int Return Explaination note Name height

getClickedZAxisLabel

public DrillDownDetail getClickedZAxisLabel(int click_x,
                                            int click_y)

Returns the DrillDownDetail object where mouse click

Parameters:

click_x - x coordinate of click position

click_y - y coordinate of click position

Returns:

DrillDownDetail DrillDownDetail object where mouse click