com.steema.teechart.styles
Class Calendar

java.lang.Object
  extended by com.steema.teechart.TeeBase
      extended by com.steema.teechart.styles.Series
          extended by com.steema.teechart.styles.Calendar
All Implemented Interfaces:
ISeries, java.io.Serializable, java.lang.Cloneable

public class Calendar
extends Series

Title: Calendar class

Description: Calendar Series.

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

Company: Steema Software SL

See Also:
Serialized Form

Nested Class Summary
 class Calendar.CalendarCell
          Title: CalendarCell class Description: Contains the characteristics of each Calendar Cell.
 class Calendar.CalendarCellUpper
          Title: CalendarCellUpper class Description: Format information for the upper row cells of the Calendar Series.
 
Nested classes/interfaces inherited from class com.steema.teechart.styles.Series
Series.MarkTextResolver
 
Field Summary
protected  DateTimeResolver customDate
           
 int dayOneColumn
           
 int dayOneRow
           
 
Fields inherited from class com.steema.teechart.styles.Series
AUTODEPTH, AUTOZORDER, bActive, bBrush, bColorEach, calcVisiblePoints, colorMember, customMarkText, drawBetweenPoints, endZ, firstVisible, hasZValues, iColors, InternalUse, iNumSampleValues, iZOrder, labelMember, lastVisible, listenerList, mandatory, manualData, marks, middleZ, notMandatory, percentDecimal, percentFormat, sLabels, startZ, useAxis, useSeriesColor, valueFormat, vxValues, vyValues, yMandatory
 
Fields inherited from class com.steema.teechart.TeeBase
chart
 
Constructor Summary
Calendar()
           
Calendar(IBaseChart c)
           
 
Method Summary
protected  DateTime cellDate(int aCol, int aRow)
           
protected  void checkClick(int x, int y)
           
protected  void checkClick(java.awt.Point p)
           
 int clicked(int x, int y)
          Returns the ValueIndex of the "clicked" point in the Series.
protected  void draw()
           
protected  void drawCell(Calendar.CalendarCell cell, int column, int row, java.lang.String text)
           
 int getColumns()
          Returns the number of Columns present in the Calender Series.
 DateTime getDate()
          Defines a day and causes Calender Series to display the associated month.
 Calendar.CalendarCell getDays()
          Defines Calender Cell appearance characteristics for calender days.
 java.lang.String getDescription()
          Gets description text.
 int getMonth()
          Returns month number of currently displayed month.
 Calendar.CalendarCellUpper getMonths()
          Defines Calender Cell appearance for the month name.
 javax.swing.JButton getNextMonthButton()
          Gets the month after the present one.
 ChartPen getPen()
          Element Pen Characteristics.
 java.awt.Menu getPopupMenu()
          Returns the popupmenu used by the calendar to show all the month names (when rightclicking the month name on the calendar).
 javax.swing.JButton getPreviousMonthButton()
          Gets the month before the present one.
 int getRows()
          Returns the number of Rows present in the Calender Series.
 Calendar.CalendarCell getSunday()
          Defines Calender Cell appearance for all Sundays.
 Calendar.CalendarCell getToday()
          Defines Calender Cell appearance for the highlighted day.
 Calendar.CalendarCell getTrailing()
          Defines Calender Cell appearance for the trailing days.
 Calendar.CalendarCellUpper getWeekDays()
          Defines Calender Cell appearance for weekday titles.
 void monthClick(java.lang.Object sender)
           
 java.awt.Cursor mouseEvent(java.awt.event.MouseEvent e, java.awt.Cursor c)
           
 void nextMonth()
          Moves the Calender series onto the month after the present one.
protected  int numSampleValues()
           
 void prepareForGallery(boolean isEnabled)
           
 void previousMonth()
          Moves the Calender series onto the month before the present one.
protected  java.lang.Object readResolve()
           
 Rectangle rectCell(int column, int row)
          Returns the bounderies of a 2D-Rectangle defining the outline of the specified Calender series cell.
 void removeDateTimeResolver()
           
 void setActive(boolean value)
          Shows or hides this series.
 void setChart(IBaseChart c)
          Chart associated with this object.
 void setDate(DateTime value)
          Sets a day and causes Calender Series to display the associated month.
 void setDateTimeResolver(DateTimeResolver resolver)
           
 
Methods inherited from class com.steema.teechart.styles.Series
add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, add, addChartValue, added, addNull, addNullXY, addSampleValues, addSeriesMouseListener, addSeriesPaintListener, addValues, assign, assignDispose, assignValues, associatedToAxis, beginUpdate, calcFirstLastVisibleIndex, calcHorizMargins, calcPosValue, calcVerticalMargins, calcXPos, calcXPosValue, calcXSizeValue, calcYPos, calcYPosValue, calcYSizeValue, calcZOrder, canAddRandomPoints, changeType, checkDataSource, checkMouse, checkOrder, checkOtherSeries, clear, clearLists, clicked, clone, cloneSeries, convertArray, createNewSeries, createNewSeries, createSubGallery, dataSourceArray, delete, delete, delete, dispose, doAfterDrawValues, doBeforeDrawChart, doBeforeDrawValues, doClick, doClickPointer, doDoubleClick, drawLegend, drawLegend, drawLegendShape, drawMark, drawMarks, drawSeries, drawSeriesForward, drawValue, drawValuesForward, endUpdate, fillSampleValues, fillSampleValues, fireSeriesMouseEvent, fireSeriesPaint, galleryChanged3D, getActive, getAllowSinglePoint, getBitmapEditor, getColor, getColorEach, getColorMember, getColors, getCount, getCountLegendItems, getCursor, getCustomHorizAxis, getCustomVertAxis, getDataSource, getDepth, getEndZ, getFields, getFirstVisible, getFunction, getHasZValues, getHorizAxis, getHorizontalAxis, getLabelMember, getLabels, getLastVisible, getLegendString, getMandatory, getMarks, getMarkText, getMarkValue, getMaxXValue, getMaxYValue, getMaxZValue, getMiddleZ, getMinXValue, getMinYValue, getMinZValue, getNotMandatory, getNumGallerySeries, getNumSampleValues, getOriginValue, getPercentFormat, getPoint, getSeriesColor, getShowInLegend, getStartZ, getTitle, getUseAxis, getValueColor, getValueFormat, getValueIndexSwapper, getValueList, getValueList, getValueMarkText, getValuesLists, getVertAxis, getVerticalAxis, getVisible, getXValues, getYMandatory, getYValueList, getYValues, getZOrder, hasDataSource, hasListenersOf, hasNoMandatoryValues, isNull, isValidSeriesSource, isValidSourceOf, legendItemColor, legendToValueIndex, maxMarkWidth, moreSameZOrder, newFromType, onDisposing, paintLegend, prepareLegendCanvas, randomBounds, recalcGetAxis, refreshSeries, removeMarkTextResolver, removeSeriesMouseListener, removeSeriesPaintListener, repaint, sameClass, setColor, setColorEach, setColorMember, setColors, setCursor, setCustomHorizAxis, setCustomHorizAxis, setCustomVertAxis, setCustomVertAxis, setDataSource, setDepth, setEndZ, setFunction, setHorizontal, setHorizontalAxis, setLabelMember, setLabels, setMarks, setMarkTextResolver, setMiddleZ, setNull, setPercentFormat, setSeriesColor, setShowInLegend, setStartZ, setSubGallery, setTitle, setValueFormat, setValueList, setVerticalAxis, setVisible, setXValues, setYValues, setZOrder, setZPositions, sortByLabels, sortByLabels, swapValueIndex, titleOrName, toString, valuesListAdd, xScreenToValue, yScreenToValue
 
Methods inherited from class com.steema.teechart.TeeBase
getChart, invalidate, setBooleanProperty, setColorProperty, setColorProperty, setDoubleProperty, setIntegerProperty, setStringProperty
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.steema.teechart.styles.ISeries
getChart, invalidate
 

Field Detail

customDate

protected transient DateTimeResolver customDate

dayOneRow

public int dayOneRow

dayOneColumn

public int dayOneColumn
Constructor Detail

Calendar

public Calendar()

Calendar

public Calendar(IBaseChart c)
Method Detail

readResolve

protected java.lang.Object readResolve()
Overrides:
readResolve in class Series

setDateTimeResolver

public void setDateTimeResolver(DateTimeResolver resolver)

removeDateTimeResolver

public void removeDateTimeResolver()

getPen

public ChartPen getPen()
Element Pen Characteristics.

Returns:
ChartPen

getDate

public DateTime getDate()
Defines a day and causes Calender Series to display the associated month.

Returns:
DateTime

setDate

public void setDate(DateTime value)
Sets a day and causes Calender Series to display the associated month.

Parameters:
value - DateTime

drawCell

protected void drawCell(Calendar.CalendarCell cell,
                        int column,
                        int row,
                        java.lang.String text)

mouseEvent

public java.awt.Cursor mouseEvent(java.awt.event.MouseEvent e,
                                  java.awt.Cursor c)
Overrides:
mouseEvent in class Series

prepareForGallery

public void prepareForGallery(boolean isEnabled)
Overrides:
prepareForGallery in class Series

getDays

public Calendar.CalendarCell getDays()
Defines Calender Cell appearance characteristics for calender days.

Returns:
CalendarCell

getWeekDays

public Calendar.CalendarCellUpper getWeekDays()
Defines Calender Cell appearance for weekday titles.

Returns:
CalendarCellUpper

getMonths

public Calendar.CalendarCellUpper getMonths()
Defines Calender Cell appearance for the month name.

Returns:
CalendarCellUpper

getToday

public Calendar.CalendarCell getToday()
Defines Calender Cell appearance for the highlighted day.

Returns:
CalendarCell

getSunday

public Calendar.CalendarCell getSunday()
Defines Calender Cell appearance for all Sundays.

Returns:
CalendarCell

getTrailing

public Calendar.CalendarCell getTrailing()
Defines Calender Cell appearance for the trailing days.

Returns:
CalendarCell

getNextMonthButton

public javax.swing.JButton getNextMonthButton()
Gets the month after the present one.
Returns the button used to scroll the calendar to "next" month.

Returns:
JButton

getPreviousMonthButton

public javax.swing.JButton getPreviousMonthButton()
Gets the month before the present one.
Returns the button used to scroll the calendar to "previous" month.

Returns:
JButton

numSampleValues

protected int numSampleValues()
Overrides:
numSampleValues in class Series

clicked

public int clicked(int x,
                   int y)
Returns the ValueIndex of the "clicked" point in the Series.

Specified by:
clicked in interface ISeries
Overrides:
clicked in class Series
Parameters:
x - int
y - int
Returns:
int

rectCell

public Rectangle rectCell(int column,
                          int row)
Returns the bounderies of a 2D-Rectangle defining the outline of the specified Calender series cell.

Parameters:
column - int
row - int
Returns:
Rectangle

monthClick

public void monthClick(java.lang.Object sender)

setActive

public void setActive(boolean value)
Description copied from class: Series
Shows or hides this series.

Specified by:
setActive in interface ISeries
Overrides:
setActive in class Series
Parameters:
value - boolean

setChart

public void setChart(IBaseChart c)
Description copied from class: TeeBase
Chart associated with this object.

Specified by:
setChart in interface ISeries
Overrides:
setChart in class Series
Parameters:
c - IBaseChart

getRows

public int getRows()
Returns the number of Rows present in the Calender Series.

Returns:
int

draw

protected void draw()
Overrides:
draw in class Series

getDescription

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

Overrides:
getDescription in class Series
Returns:
String

cellDate

protected DateTime cellDate(int aCol,
                            int aRow)

getColumns

public int getColumns()
Returns the number of Columns present in the Calender Series.

Returns:
int

getPopupMenu

public java.awt.Menu getPopupMenu()
Returns the popupmenu used by the calendar to show all the month names (when rightclicking the month name on the calendar).
This popupmenu is used to go to the desired month.

Returns:
Menu

checkClick

protected void checkClick(int x,
                          int y)

checkClick

protected void checkClick(java.awt.Point p)

nextMonth

public void nextMonth()
Moves the Calender series onto the month after the present one.


previousMonth

public void previousMonth()
Moves the Calender series onto the month before the present one.


getMonth

public int getMonth()
Returns month number of currently displayed month.

Returns:
int