Class fvaswing.components.FvCalendarField

Implemented Interfaces

FvCalendarListener LocalisationListener

Description

calendar basic field component.

Use a textfield and a FvCalendar sub components.

If you want to use auto validation process, take a look at FvDateField component.

Method Index

new FvCalendarField()
clear(), connectToLocalisation(), getFormatPattern(), getIcon(), getMaximumYear(), getMinimumYear(), getText(), getValue(), isShowTodayEnabled(), onCalendarClick(), onLocalisationUpdate(), setFormatPattern(), setIcon(), setMaximumYear(), setMinimumYear(), setShowTodayEnabled(), setValue(), toString()

Constructor Detail

FvCalendarField

public function FvCalendarField()

Constructor.

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.

setFormatPattern

public function setFormatPattern(pattern:String):Void

Sets the formatting pattern to use when receive date from FvCalendar component.

Default is connected to the Localisation API

getFormatPattern

public function getFormatPattern():String

Returns used formatting pattern.

connectToLocalisation

public function connectToLocalisation():Void

Connects instance to localisation API.
Automatically update the formatting pattern using localisation pattern definition.

setValue

public function setValue(date:Date):Void

Sets combobox selected item.

getValue

public function getValue():Date

Returns selected date.

getText

public function getText():String

Returns result in string format using textfield content.

clear

public function clear():Void

Clears textfield.

setIcon

public function setIcon(icon:Icon):Void

Sets button icon.

getIcon

public function getIcon():Icon

Returns button icon.

onLocalisationUpdate

public function onLocalisationUpdate(event:LocalisationEvent):Void

Triggered when localisation change.

Specified By

onLocalisationUpdate() in fever.app.local.LocalisationListener

onCalendarClick

public function onCalendarClick(date:Date):Void

Triggered by FvCalendar component when a date is selected.

Specified By

onCalendarClick() in fvaswing.components.datechooser.FvCalendarListener

toString

public function toString():String

Returns string representation.