com.keepcore.calendar.model.CalendarItem

	Property	Defined By
		AddedAuthor : Number Getter for FAddedAuthor	CalendarItem
		calendar : KCCalendar	CalendarItem
		calendarObject : Object	CalendarItem
		concurrentDayRanges : ArrayCollection Concurrent day ranges.	CalendarItem
		concurrentItems : ArrayCollection Concurrent item list.	CalendarItem
		dateRange : DateRange Define the date range of the item.	CalendarItem
		dateRangeEnd : Date [write-only] Set the date range end of the item.	CalendarItem
		intersectionList : IntersectionList	CalendarItem
		invalidRange : Boolean	CalendarItem
		isSelected : Boolean	CalendarItem
		itemY : Number	CalendarItem
		noteList : NoteList Getter for _noteList	CalendarItem
		renderers : ArrayCollection	CalendarItem
		resizable : Boolean	CalendarItem
		secondaryItemY : Number	CalendarItem
		UpdatedAuthor : Number Getter for FUpdatedAuthor	CalendarItem
		visible : Boolean	CalendarItem
		yearViewRenderers : ArrayCollection	CalendarItem

	Property	Defined By
		_addedAuthor : Number	CalendarItem
		_addedDate : Date	CalendarItem
		_deletedDate : Date	CalendarItem
		_noteList : NoteList	CalendarItem
		_updatedAuthor : Number	CalendarItem
		_updatedDate : Date	CalendarItem

	Method	Defined By
		CalendarItem(calendar:KCCalendar)	CalendarItem
		addRenderer(AId:Number, onlyMouseEvents:Boolean = false, renderer:ICalendarItemRenderer = null):void create a new renderer for the item	CalendarItem
		addYearRenderer(AId:Number, onlyMouseEvents:Boolean = false, renderer:ICalendarItemRenderer = null):void Create a new renderer for the item for year view	CalendarItem
		clearCache():void Clear the cache.	CalendarItem
		clone():CalendarItem	CalendarItem
		compareCalendarItemByDate(a:Object, b:Object, fields:Array = null):int [static] The method used to compare Calendar items when sorting (used for compareFunction in Sort objects).	CalendarItem
		dateRangeMoveTo(value:Date):void Move the date range to the specified date.	CalendarItem
		GetAddedAuthorUserName():String Getter for Added author user name	CalendarItem
		getCurrentRendererVisibleFromCache():Boolean Get renderer visibility from cache.	CalendarItem
		getFinalYFromCache():Number Get final Y from cache.	CalendarItem
		getSecondDayPartRendererVisibleFromCache():Boolean Get secondary day renderer visibility from cache.	CalendarItem
		getStatusString(aStatus:int):String [static]	CalendarItem
		GetUpdatedAuthorUserName():String Getter for Update author user name	CalendarItem
		invalidateDisplayList():void	CalendarItem
		invalidateProperties():void	CalendarItem
		isAllDay(overridenEndDate:Date = null):Boolean Return if the item has to be displayed on several days Important note: full day event are described with a end date set at day+1 but with 00:00 as hour/minutes	CalendarItem
		isSameAsCache(Ax:int, originalX:int, Ay:Number, AWidth:Number, AHeight:Number, itemColumn:int, isSpecialEventSplitOn2Days:Boolean, secondDayHeight:Number, indexOfRenderer:int, dayIndex:int):Boolean Compare main display parameters against the cache.	CalendarItem
		isSameAsMonthCache(Ax:int, originalX:int, Ay:int, Aj:int, AWidth:int, AHeight:int, cellWidth:int, cellHeight:int):Boolean Compare main display parameters against the cache.	CalendarItem
		mouseClickHandler(event:MouseEvent):void	CalendarItem
		mouseDoubleClickHandler(event:MouseEvent):void	CalendarItem
		mouseDownHandler(event:MouseEvent):void	CalendarItem
		mouseRollOutHandler(event:MouseEvent):void	CalendarItem
		mouseRollOverHandler(event:MouseEvent):void	CalendarItem
		mouseUpHandler(event:MouseEvent):void	CalendarItem
		notesAndAckItemHandler(event:Event):void	CalendarItem
		NotesDataTip():String Returns a tooltip for the notes column, depending on the number of notes available for the specified item	CalendarItem
		setCache(Ax:int, originalX:int, Ay:Number, finalAy:Number, AWidth:Number, AHeight:Number, itemColumn:int, isSpecialEventSplitOn2Days:Boolean, secondDayHeight:Number, indexOfRenderer:int, dayIndex:int, currentRendererVisible:Boolean, secondDayPartRendererVisible:Boolean):void Store main display parameters in a cache to optimize next displays.	CalendarItem
		setMonthCache(Ax:int, originalX:int, Ay:int, Aj:int, AWidth:int, AHeight:int, cellWidth:int, cellHeight:int):void	CalendarItem
		StatusDataTip():String	CalendarItem
		toString():String [override]	CalendarItem
		updateRenderers():void	CalendarItem

	Constant	Defined By
		MOVE_ITEM : String = MOVE_ITEM [static]	CalendarItem
		RESIZE_ITEM : String = RESIZE_ITEM [static]	CalendarItem

Property Detail

_addedAuthor

property

protected var _addedAuthor:Number

_addedDate

property

protected var _addedDate:Date

_deletedDate

property

protected var _deletedDate:Date

_noteList

property

protected var _noteList:NoteList

_updatedAuthor

property

protected var _updatedAuthor:Number

_updatedDate

property

protected var _updatedDate:Date

AddedAuthor

property

AddedAuthor:Number

Getter for FAddedAuthor

Implementation
public function get AddedAuthor():Number
public function set AddedAuthor(value:Number):void

calendar

property

calendar:KCCalendar

Implementation
public function get calendar():KCCalendar
public function set calendar(value:KCCalendar):void

calendarObject

property

calendarObject:Object

Implementation
public function get calendarObject():Object
public function set calendarObject(value:Object):void

concurrentDayRanges

property

concurrentDayRanges:ArrayCollection

Concurrent day ranges.

Implementation
public function get concurrentDayRanges():ArrayCollection
public function set concurrentDayRanges(value:ArrayCollection):void

concurrentItems

property

concurrentItems:ArrayCollection

Concurrent item list.

Implementation
public function get concurrentItems():ArrayCollection
public function set concurrentItems(value:ArrayCollection):void

dateRange

property

dateRange:DateRange

Define the date range of the item. Upon change, a check is done to know if some renderers should be added/modified/removed

Implementation
public function get dateRange():DateRange
public function set dateRange(value:DateRange):void

dateRangeEnd

property

dateRangeEnd:Date [write-only]

Set the date range end of the item.

Implementation
public function set dateRangeEnd(value:Date):void

intersectionList

property

intersectionList:IntersectionList

Implementation
public function get intersectionList():IntersectionList
public function set intersectionList(value:IntersectionList):void

invalidRange

property

invalidRange:Boolean

Implementation
public function get invalidRange():Boolean
public function set invalidRange(value:Boolean):void

isSelected

property

isSelected:Boolean

Implementation
public function get isSelected():Boolean
public function set isSelected(value:Boolean):void

itemY

property

itemY:Number

Implementation
public function get itemY():Number
public function set itemY(value:Number):void

noteList

property

noteList:NoteList

Getter for _noteList

Implementation
public function get noteList():NoteList
public function set noteList(value:NoteList):void

renderers

property

renderers:ArrayCollection

Implementation
public function get renderers():ArrayCollection
public function set renderers(value:ArrayCollection):void

resizable

property

resizable:Boolean

Implementation
public function get resizable():Boolean
public function set resizable(value:Boolean):void

secondaryItemY

property

secondaryItemY:Number

Implementation
public function get secondaryItemY():Number
public function set secondaryItemY(value:Number):void

UpdatedAuthor

property

UpdatedAuthor:Number

Getter for FUpdatedAuthor

Implementation
public function get UpdatedAuthor():Number
public function set UpdatedAuthor(value:Number):void

visible

property

visible:Boolean

Implementation
public function get visible():Boolean
public function set visible(value:Boolean):void

yearViewRenderers

property

yearViewRenderers:ArrayCollection

Implementation
public function get yearViewRenderers():ArrayCollection
public function set yearViewRenderers(value:ArrayCollection):void

Constructor Detail

CalendarItem

()

Constructor

public function CalendarItem(calendar:KCCalendar)

Parameters

calendar:KCCalendar

Method Detail

addRenderer

()

method

public function addRenderer(AId:Number, onlyMouseEvents:Boolean = false, renderer:ICalendarItemRenderer = null):void

create a new renderer for the item

Parameters

	`AId:Number`

	`onlyMouseEvents:Boolean` (default = `false`)

	`renderer:ICalendarItemRenderer` (default = `null`)

addYearRenderer

()

method

 public function addYearRenderer(AId:Number, onlyMouseEvents:Boolean = false, renderer:ICalendarItemRenderer = null):void

Create a new renderer for the item for year view

Parameters

	`AId:Number`

	`onlyMouseEvents:Boolean` (default = `false`)

	`renderer:ICalendarItemRenderer` (default = `null`)

clearCache

()

method

public function clearCache():void

Clear the cache.

clone

()

method

public function clone():CalendarItem

Returns

CalendarItem

compareCalendarItemByDate

()

method

public static function compareCalendarItemByDate(a:Object, b:Object, fields:Array = null):int

The method used to compare Calendar items when sorting (used for compareFunction in Sort objects).

Parameters

	`a:Object` — first CalendarItem

	`b:Object` — second CalendarItem

	`fields:Array` (default = `null`) — useless, only to match compareFunction signature

Returns

int —

-1, if a should appear before b in the sorted sequence
0, if a equals b
1, if a should appear after b in the sorted sequence

dateRangeMoveTo

()

method

public function dateRangeMoveTo(value:Date):void

Move the date range to the specified date.

Parameters

value:Date — date to move to.

GetAddedAuthorUserName

()

method

public function GetAddedAuthorUserName():String

Getter for Added author user name

Returns

String — added author user name

getCurrentRendererVisibleFromCache

()

method

public function getCurrentRendererVisibleFromCache():Boolean

Get renderer visibility from cache.

Returns

Boolean

getFinalYFromCache

()

method

public function getFinalYFromCache():Number

Get final Y from cache.

Returns

Number

getSecondDayPartRendererVisibleFromCache

()

method

public function getSecondDayPartRendererVisibleFromCache():Boolean

Get secondary day renderer visibility from cache.

Returns

Boolean

getStatusString

()

method

public static function getStatusString(aStatus:int):String

Parameters

aStatus:int

Returns

String

GetUpdatedAuthorUserName

()

method

public function GetUpdatedAuthorUserName():String

Getter for Update author user name

Returns

String — update author user name

invalidateDisplayList

()

method

public function invalidateDisplayList():void

invalidateProperties

()

method

public function invalidateProperties():void

isAllDay

()

method

public function isAllDay(overridenEndDate:Date = null):Boolean

Return if the item has to be displayed on several days Important note: full day event are described with a end date set at day+1 but with 00:00 as hour/minutes

Parameters

overridenEndDate:Date (default = null)

Returns

Boolean

isSameAsCache

()

method

 public function isSameAsCache(Ax:int, originalX:int, Ay:Number, AWidth:Number, AHeight:Number, itemColumn:int, isSpecialEventSplitOn2Days:Boolean, secondDayHeight:Number, indexOfRenderer:int, dayIndex:int):Boolean

Compare main display parameters against the cache.

Parameters

	`Ax:int`

	`originalX:int`

	`Ay:Number`

	`AWidth:Number`

	`AHeight:Number`

	`itemColumn:int`

	`isSpecialEventSplitOn2Days:Boolean`

	`secondDayHeight:Number`

	`indexOfRenderer:int`

	`dayIndex:int`

Returns

Boolean

isSameAsMonthCache

()

method

 public function isSameAsMonthCache(Ax:int, originalX:int, Ay:int, Aj:int, AWidth:int, AHeight:int, cellWidth:int, cellHeight:int):Boolean

Compare main display parameters against the cache.

Parameters

	`Ax:int`

	`originalX:int`

	`Ay:int`

	`Aj:int`

	`AWidth:int`

	`AHeight:int`

	`cellWidth:int`

	`cellHeight:int`

Returns

Boolean

mouseClickHandler

()

method

public function mouseClickHandler(event:MouseEvent):void

Parameters

event:MouseEvent

mouseDoubleClickHandler

()

method

public function mouseDoubleClickHandler(event:MouseEvent):void

Parameters

event:MouseEvent

mouseDownHandler

()

method

public function mouseDownHandler(event:MouseEvent):void

Parameters

event:MouseEvent

mouseRollOutHandler

()

method

public function mouseRollOutHandler(event:MouseEvent):void

Parameters

event:MouseEvent

mouseRollOverHandler

()

method

public function mouseRollOverHandler(event:MouseEvent):void

Parameters

event:MouseEvent

mouseUpHandler

()

method

public function mouseUpHandler(event:MouseEvent):void

Parameters

event:MouseEvent

notesAndAckItemHandler

()

method

public function notesAndAckItemHandler(event:Event):void

Parameters

event:Event

NotesDataTip

()

method

public function NotesDataTip():String

Returns a tooltip for the notes column, depending on the number of notes available for the specified item

Returns

String

setCache

()

method

 public function setCache(Ax:int, originalX:int, Ay:Number, finalAy:Number, AWidth:Number, AHeight:Number, itemColumn:int, isSpecialEventSplitOn2Days:Boolean, secondDayHeight:Number, indexOfRenderer:int, dayIndex:int, currentRendererVisible:Boolean, secondDayPartRendererVisible:Boolean):void

Store main display parameters in a cache to optimize next displays.

Parameters

	`Ax:int`

	`originalX:int`

	`Ay:Number`

	`finalAy:Number`

	`AWidth:Number`

	`AHeight:Number`

	`itemColumn:int`

	`isSpecialEventSplitOn2Days:Boolean`

	`secondDayHeight:Number`

	`indexOfRenderer:int`

	`dayIndex:int`

	`currentRendererVisible:Boolean`

	`secondDayPartRendererVisible:Boolean`

setMonthCache

()

method

 public function setMonthCache(Ax:int, originalX:int, Ay:int, Aj:int, AWidth:int, AHeight:int, cellWidth:int, cellHeight:int):void

Parameters

	`Ax:int`

	`originalX:int`

	`Ay:int`

	`Aj:int`

	`AWidth:int`

	`AHeight:int`

	`cellWidth:int`

	`cellHeight:int`

StatusDataTip

()

method

public function StatusDataTip():String

Returns

String

toString

()

method

override public function toString():String

Returns

String

updateRenderers

()

method

public function updateRenderers():void

Constant Detail

MOVE_ITEM

Constant

public static const MOVE_ITEM:String = MOVE_ITEM

RESIZE_ITEM

Constant

public static const RESIZE_ITEM:String = RESIZE_ITEM

Lundi Octobre 31 2011, 04:36 PM +01:00

KCCalendarLibrary4.5.1	All Packages \| All Classes \| Index \| Frames No Frames
CalendarItem	Properties \| Methods \| Constants

Package	com.keepcore.calendar.model
Class	public class CalendarItem
Inheritance	CalendarItem flash.events.EventDispatcher