ElegantJCharts Java API Specification v2.0

com.elegantj.graphx.candle
Class GraphCandleDetail

java.lang.Object
  |
  +--com.elegantj.graphx.candle.GraphCandleDetail
All Implemented Interfaces:
java.io.Externalizable, java.io.Serializable

public class GraphCandleDetail
extends java.lang.Object
implements java.io.Externalizable

Detail for Graph Title like Title text, Color, Font etc. Gap between two group of Bars Bar Width can be specified Bar Border is Visible/Hide Bar Border Style/Color Bar Gradient is Visible/Hide Bar Gradient Style/Color Bar Tooltip text

See Also:
Serialized Form

Constructor Summary
GraphCandleDetail()
          Constructor
 
Method Summary
 com.elegantj.editors.AWTBorder getBarBorder()
          get Bar Border Object
 boolean getBarBorderVisible()
          get Bar Border Visible/hide
 java.util.Vector getBarColors()
          Get Bar Properties
 int getBarGapInPercent()
          Get Gap between two Bar Group in Percentage
 int getBarWidth()
          Get Bar width
 int getCandleTransperancyInPercent()
          get transperancy value of color
 java.awt.Color getEmptyBodyColor()
          This method returns the Real body Color [Empty: Open < close ]
 java.awt.Color getFilledBodyColor()
          This method returns the Real body Color [Filled: Open > close ]
 int getRealBodyWidth()
          This method returns the Real body Width
 java.awt.Color getShadowLineColor()
          This method returns the Shadow Line Color
 int getShadowLineWidth()
          This method returns the Shadow Line Width
 java.lang.String getTooltipText()
          get Bar Tooltip Text
 java.awt.Color getTransParentColor(java.awt.Color theColor)
           
 void readExternal(java.io.ObjectInput in)
          This method retrieves the state of the bean
 void setBarBorder(com.elegantj.editors.AWTBorder newBorder)
          set Bar Border Object
 void setBarBorderVisible(boolean visible)
          set Bar Border Visible/Hide
 void setBarColors(java.util.Vector invalue)
          Set Bar Properties
 void setBarGapInPercent(int gapInPercent)
          Set Gap between two Bar group in Percentage
 void setBarWidth(int width)
          Set Bar Width
 void setCandleTransperancyInPercent(int transperancyInPercent)
          set Transperancy in Bar color
 void setEmptyBodyColor(java.awt.Color inEmptyBodyColor)
          This method sets the Real body Color [Empty: Open < close ]
 void setFilledBodyColor(java.awt.Color inFilledBodyColor)
          This method sets the Real body Color [Filled: Open > close ]
 void setRealBodyWidth(int inRealBodyWidth)
          This method sets the Real body Width
 void setShadowLineColor(java.awt.Color inShadowLineColor)
          This method sets the Shadow Line Color
 void setShadowLineWidth(int inShadowLineWidth)
          This method sets the Shadow Line Width
 void setTooltipText(java.lang.String tooltip)
          set Bar Tooltip text
 void writeExternal(java.io.ObjectOutput out)
          This method saves the state of the bean
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GraphCandleDetail

public GraphCandleDetail()
Constructor

Method Detail

setBarGapInPercent

public void setBarGapInPercent(int gapInPercent)
Set Gap between two Bar group in Percentage

Parameters:
gapInPercent - Percentage of gap between two Bar Group

getBarGapInPercent

public int getBarGapInPercent()
Get Gap between two Bar Group in Percentage

Returns:
int Specifying the Percentage of gap between two Bar

setBarWidth

public void setBarWidth(int width)
Set Bar Width

Parameters:
width - Bar width

getBarWidth

public int getBarWidth()
Get Bar width

Returns:
int bar width

setBarColors

public void setBarColors(java.util.Vector invalue)
Set Bar Properties

Parameters:
invalue - Vector of Bar properties

getBarColors

public java.util.Vector getBarColors()
Get Bar Properties

Returns:
Vector Bar property vector

setCandleTransperancyInPercent

public void setCandleTransperancyInPercent(int transperancyInPercent)
set Transperancy in Bar color

Parameters:
transperancyInPercent - Percentage of trancparency in color

getCandleTransperancyInPercent

public int getCandleTransperancyInPercent()
get transperancy value of color

Returns:
int Specifying the Percantage of transperancy of color

setBarBorderVisible

public void setBarBorderVisible(boolean visible)
set Bar Border Visible/Hide

Parameters:
visible - if true then Bar border is visible otherwize not

getBarBorderVisible

public boolean getBarBorderVisible()
get Bar Border Visible/hide

Returns:
boolean true - Bar border is visible otherwize not

setBarBorder

public void setBarBorder(com.elegantj.editors.AWTBorder newBorder)
set Bar Border Object

Parameters:
newBorder - border Object specifying border properties

getBarBorder

public com.elegantj.editors.AWTBorder getBarBorder()
get Bar Border Object

Returns:
AWTBorder border Object specifying border properties

setTooltipText

public void setTooltipText(java.lang.String tooltip)
set Bar Tooltip text

Parameters:
tooltip - String representing Bar tooltip text

getTooltipText

public java.lang.String getTooltipText()
get Bar Tooltip Text

Returns:
String String Object representing Bar Tooltip Text

setShadowLineColor

public void setShadowLineColor(java.awt.Color inShadowLineColor)
This method sets the Shadow Line Color

Parameters:
inShadowLineColor - the Shadow Line Color representing the High and Low value

getShadowLineColor

public java.awt.Color getShadowLineColor()
This method returns the Shadow Line Color

Returns:
Color the Shadow Line Color representing the High and Low value

setFilledBodyColor

public void setFilledBodyColor(java.awt.Color inFilledBodyColor)
This method sets the Real body Color [Filled: Open > close ]

Parameters:
inFilledBodyColor - the Real body Color representing the Open and Close value

getFilledBodyColor

public java.awt.Color getFilledBodyColor()
This method returns the Real body Color [Filled: Open > close ]

Returns:
Color the the Real body Color representing the Open and Close value

setEmptyBodyColor

public void setEmptyBodyColor(java.awt.Color inEmptyBodyColor)
This method sets the Real body Color [Empty: Open < close ]

Parameters:
inEmptyBodyColor - the Real body Color representing the Open and Close value

getEmptyBodyColor

public java.awt.Color getEmptyBodyColor()
This method returns the Real body Color [Empty: Open < close ]

Returns:
Color the Real body Color representing the Open and Close value

setRealBodyWidth

public void setRealBodyWidth(int inRealBodyWidth)
This method sets the Real body Width

Parameters:
inRealBodyWidth - the Real body Width

getRealBodyWidth

public int getRealBodyWidth()
This method returns the Real body Width


setShadowLineWidth

public void setShadowLineWidth(int inShadowLineWidth)
This method sets the Shadow Line Width

Parameters:
inShadowLineWidth - the Shadow Line Width

getShadowLineWidth

public int getShadowLineWidth()
This method returns the Shadow Line Width

Returns:
int the Shadow Line Width

getTransParentColor

public java.awt.Color getTransParentColor(java.awt.Color theColor)

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.lang.ClassNotFoundException,
                         java.io.IOException
This method retrieves the state of the bean

Specified by:
readExternal in interface java.io.Externalizable
java.lang.ClassNotFoundException
java.io.IOException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
This method saves the state of the bean

Specified by:
writeExternal in interface java.io.Externalizable
java.io.IOException

ElegantJCharts Java API Specification v2.0

For any feedback, suggestion, or query, please revert back to support@elegantcharts.com

Copyright(c)
Elegant Microweb Technologies Pvt. Ltd.
www.elegantmicroweb.com
www.elegantjcharts.com
All Rights Reserved.