com.steema.teechart.tools
Class GanttTool

java.lang.Object
  com.steema.teechart.TeeBase
      com.steema.teechart.tools.Tool
          com.steema.teechart.tools.ToolSeries
              com.steema.teechart.tools.GanttTool

All Implemented Interfaces:

java.io.Serializable

public class GanttTool
extends ToolSeries

Title: GanttTool class

Description: Gantt Tool.

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

Company: Steema Software SL

See Also:

Serialized Form

Nested Class Summary

class

GanttTool.DragGanttBar

Field Summary

static int	HANDLE_ALL
static int	HANDLE_END
static int	HANDLE_START

Fields inherited from class com.steema.teechart.tools.ToolSeries

iSeries

Fields inherited from class com.steema.teechart.tools.Tool

bBrush, clickTolerance, listenerList, pPen

Fields inherited from class com.steema.teechart.TeeBase

chart

Constructor Summary

GanttTool()

GanttTool(IBaseChart c)

Method Summary

void	addDragListener(DragListener l)
void	addSizeListener(SizeListener l)
boolean	getAllowDrag() When true, the end user can use the mouse to click and drag Gantt series bars.
boolean	getAllowResize() When true, the end user can use the mouse to resize Gantt series bars.
java.awt.Cursor	getCursorDrag() The cursor to show when the user is dragging a Gantt bar.
java.awt.Cursor	getCursorResize() The cursor to show when the end user passes the mouse over an edge (left or right) of a gantt series bar.
java.lang.String	getDescription() Gets descriptive text.
GanttTool.DragGanttBar	getDragItem()
Gantt	getGantt()
int	getMinPixels() The amount in screen pixels to consider the user is moving the mouse over a gantt bar edge (left or right).
java.lang.String	getSummary() Gets detailed descriptive text.
java.awt.Cursor	mouseEvent(java.awt.event.MouseEvent e, java.awt.Cursor c)
void	removeDragListener(DragListener l)
void	removeSizeListener(SizeListener l)
void	setAllowDrag(boolean value)
void	setAllowResize(boolean value) When true, the end user can use the mouse to resize Gantt series bars.
void	setCursorDrag(java.awt.Cursor value) Defines the cursor to show when the user is dragging a Gantt bar.
void	setCursorResize(java.awt.Cursor value) Defines the cursor to show when the end user passes the mouse over an edge (left or right) of a gantt series bar.
void	setMinPixels(int value) Defines the amount in screen pixels to consider the user is moving the mouse over a gantt bar edge (left or right).

Methods inherited from class com.steema.teechart.tools.ToolSeries

getHorizAxis, getSeries, getVertAxis, setSeries

Methods inherited from class com.steema.teechart.tools.Tool

addMouseMotionListener, chartEvent, fireChanged, fireClicked, fireDragged, fireDragging, fireMouse, fireResized, getActive, getBitmapEditor, readResolve, removeMouseMotionListener, setActive, setChart, toString

Methods inherited from class com.steema.teechart.TeeBase

getChart, invalidate, setBooleanProperty, setColorProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty

Methods inherited from class java.lang.Object

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

Field Detail

HANDLE_ALL

public static final int HANDLE_ALL

See Also:

Constant Field Values

HANDLE_START

public static final int HANDLE_START

See Also:

Constant Field Values

HANDLE_END

public static final int HANDLE_END

See Also:

Constant Field Values

Constructor Detail

GanttTool

public GanttTool()

GanttTool

public GanttTool(IBaseChart c)

Method Detail

addSizeListener

public void addSizeListener(SizeListener l)

removeSizeListener

public void removeSizeListener(SizeListener l)

addDragListener

public void addDragListener(DragListener l)

removeDragListener

public void removeDragListener(DragListener l)

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

getGantt

public Gantt getGantt()

getDragItem

public GanttTool.DragGanttBar getDragItem()

getAllowDrag

public boolean getAllowDrag()

When true, the end user can use the mouse to click and drag Gantt series bars.
Default value: true

Returns:

boolean

setAllowDrag

public void setAllowDrag(boolean value)

getAllowResize

public boolean getAllowResize()

When true, the end user can use the mouse to resize Gantt series bars.
To resize a gantt bar, click and drag the mouse when it's over an edge (left or right) of the gantt bar.
Default value: true

Returns:

boolean

setAllowResize

public void setAllowResize(boolean value)

When true, the end user can use the mouse to resize Gantt series bars.
Default value: true

Parameters:

value - boolean

getCursorDrag

public java.awt.Cursor getCursorDrag()

The cursor to show when the user is dragging a Gantt bar.
Default value: Hand

Returns:

Cursor

setCursorDrag

public void setCursorDrag(java.awt.Cursor value)

Defines the cursor to show when the user is dragging a Gantt bar.
Default value: Hand

Parameters:

value - Cursor

getCursorResize

public java.awt.Cursor getCursorResize()

The cursor to show when the end user passes the mouse over an edge (left or right) of a gantt series bar.
Default value; SizeWE

Returns:

Cursor

setCursorResize

public void setCursorResize(java.awt.Cursor value)

Defines the cursor to show when the end user passes the mouse over an edge (left or right) of a gantt series bar.
Default value; SizeWE

Parameters:

value - Cursor

getMinPixels

public int getMinPixels()

The amount in screen pixels to consider the user is moving the mouse over a gantt bar edge (left or right).
Default value: 5

Returns:

int

setMinPixels

public void setMinPixels(int value)

Defines the amount in screen pixels to consider the user is moving the mouse over a gantt bar edge (left or right).
Default value: 5

Parameters:

value - int

mouseEvent

public java.awt.Cursor mouseEvent(java.awt.event.MouseEvent e,
                                  java.awt.Cursor c)

Overrides:

mouseEvent in class Tool