Class fvaswing.components.FvCalendar

Implemented Interfaces

LocalisationListener

Description

Calendar component.

Example :

  var calendar : FvCalendar = new FvCalendar();
  calendar.setMultipleSelection( true );
  calendar.setMinimumYear( 2000 );
  calendar.setMaximumYear( 2010 );
  
  var panel : JPanel = new JPane( new BorderLayout( 5, 5 ) );
  panel.append( calendar, BorderLayout.CENTER ); 
 

Field Index

onCalendarClickEVENT, onCalendarSelectionEVENT

Method Index

new FvCalendar()
getMaximumYear(), getMinimumYear(), getSelectedDate(), getSelectedDates(), isMultiSelectionEnabled(), isShowTodayEnabled(), onLocalisationUpdate(), setFirstDayOfTheWeek(), setMaximumYear(), setMinimumYear(), setMultiSelectionEnabled(), setSelectedDate(), setShowTodayEnabled(), toString()

Constructor Detail

FvCalendar

public function FvCalendar()

Constructor.

Field Detail

onCalendarSelectionEVENT

static public onCalendarSelectionEVENT:EventType
Broadcasted each time the selection change.

Depending of isMultiSelectionEnabled() result, use getSelectedDate() or getSelectedDates() method to retreive selected date(s).

onCalendarClickEVENT

static public onCalendarClickEVENT:EventType
Broadcasted when day cell receive a click.

Method Detail

setMaximumYear

public function setMaximumYear(year:Number):Void

Sets max year value.

getMaximumYear

public function getMaximumYear():Number

Returns max year value.

setMinimumYear

public function setMinimumYear(year:Number):Void

Sets min year value.

getMinimumYear

public function getMinimumYear():Number

Returns min year value.

setShowTodayEnabled

public function setShowTodayEnabled(b:Boolean):Void

Indicates if component highlight 'today' cell.
Default is true

isShowTodayEnabled

public function isShowTodayEnabled():Boolean

Returns true if calendar highlight the 'today' cell.

setFirstDayOfTheWeek

public function setFirstDayOfTheWeek(n:Number):Void

Sets the first day ( index ) of a week.
Default is

setMultiSelectionEnabled

public function setMultiSelectionEnabled(b:Boolean):Void

Sets if multiple date selection is enabled or not.
Default is false.

Use getSelectedDates() to retrieves all selected date if multiple selection is allowed.
Otherwise use getSelectedDate() method for single selection.

isMultiSelectionEnabled

public function isMultiSelectionEnabled():Boolean

Returns true if multiple date selection is enabled.

Use getSelectedDates() to retrieves all selected date if multiple selection is allowed.
Otherwise use getSelectedDate() method for single selection.

setSelectedDate

public function setSelectedDate(date:Date):Void

Sets selected date.

getSelectedDate

public function getSelectedDate():Date

Returns selected date.

If isMultiSelectionEnabled() is true return null.

getSelectedDates

public function getSelectedDates():Array

Returns selected dates.

If isMultiSelectionEnabled() is false return null.

onLocalisationUpdate

public function onLocalisationUpdate(event:LocalisationEvent):Void

Triggered when Localisation language change.

Specified By

onLocalisationUpdate() in fever.app.local.LocalisationListener

toString

public function toString():String

Returns string representation.