com.steema.teechart.tools
Class AxisArrow

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.tools.Tool
          extended by com.steema.teechart.tools.ToolAxis
              extended by com.steema.teechart.tools.AxisArrow

public class AxisArrow
extends ToolAxis

Title: AxisArrow class

Description: Axis Arrow tool.

Copyright (c) 2005-2013 by Steema Software SL. All Rights Reserved.

Company: Steema Software SL


Field Summary
 
Fields inherited from class com.steema.teechart.tools.ToolAxis
iAxis
 
Fields inherited from class com.steema.teechart.tools.Tool
bBrush, clickTolerance, listenerList, pPen
 
Fields inherited from class com.steema.teechart.TeeBase
chart, InternalUse
 
Constructor Summary
AxisArrow()
           
AxisArrow(Axis a)
           
AxisArrow(IBaseChart c)
           
 
Method Summary
 void chartEvent(ChartDrawEvent ce)
           
 ChartBrush getBrush()
          Element Brush characteristics.
 java.lang.String getDescription()
          Gets descriptive text.
 int getLength()
          The length of the Arrows.
 AxisArrowPosition getPosition()
          The position where the arrows are drawn on the Axis.
 boolean getScrollInverted()
          Reverses direction of applied Axis Arrow scroll.
 int getScrollPercent()
          The TChart scroll rate as percentage of the associated axis.
 java.lang.String getSummary()
          Gets detailed descriptive text.
 Cursor mouseEvent(FrameworkMouseEvent e, Cursor c)
           
 void setLength(int value)
          Sets the length of the Arrows.
 void setPosition(AxisArrowPosition value)
          Determines where the arrows are drawn on the Axis.
 void setScrollInverted(boolean value)
          Reverses direction of applied Axis Arrow scroll.
 void setScrollPercent(int value)
          Sets TChart scroll rate as percentage of the associated axis.
 
Methods inherited from class com.steema.teechart.tools.ToolAxis
checkDrawHidden, getAxis, getPen, setAxis
 
Methods inherited from class com.steema.teechart.tools.Tool
dispose, fireChanged, fireClicked, fireDragged, fireDragging, fireMouse, fireResized, getActive, readResolve, setActive, setChart, toString
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, invalidate, setBooleanProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AxisArrow

public AxisArrow()

AxisArrow

public AxisArrow(IBaseChart c)

AxisArrow

public AxisArrow(Axis a)
Method Detail

getLength

public int getLength()
The length of the Arrows.
Default value: 16

Returns:
int

setLength

public void setLength(int value)
Sets the length of the Arrows.
Default value: 16

Parameters:
value - int

getPosition

public AxisArrowPosition getPosition()
The position where the arrows are drawn on the Axis.
Default value: AxisArrowPosition.Both

Returns:
AxisArrowPosition

setPosition

public void setPosition(AxisArrowPosition value)
Determines where the arrows are drawn on the Axis.
Default value: AxisArrowPosition.Both

Parameters:
value - AxisArrowPosition

getBrush

public ChartBrush getBrush()
Element Brush characteristics.

Returns:
ChartBrush

chartEvent

public void chartEvent(ChartDrawEvent ce)
Overrides:
chartEvent in class Tool

getDescription

public java.lang.String getDescription()
Gets descriptive text.

Overrides:
getDescription in class Tool
Returns:
String

getSummary

public java.lang.String getSummary()
Gets detailed descriptive text.

Overrides:
getSummary in class Tool
Returns:
String

mouseEvent

public Cursor mouseEvent(FrameworkMouseEvent e,
                         Cursor c)
Overrides:
mouseEvent in class Tool

getScrollPercent

public int getScrollPercent()
The TChart scroll rate as percentage of the associated axis.
Default value: 10

Returns:
int

setScrollPercent

public void setScrollPercent(int value)
Sets TChart scroll rate as percentage of the associated axis.
Default value: 10

Parameters:
value - int

getScrollInverted

public boolean getScrollInverted()
Reverses direction of applied Axis Arrow scroll.
Default value: false

Returns:
boolean

setScrollInverted

public void setScrollInverted(boolean value)
Reverses direction of applied Axis Arrow scroll.
Default value: false

Parameters:
value - boolean