ActionScript Standard Library: class mx.controls.CalendarLayout

Main Page | Packages | Class Tree | Index | Help

Previous \| Next	Frames \| No Frames
Summary: Field \| Property \| Contructor \| Method	Detail: Field \| Property \| Contructor \| Method

mx.controls

class CalendarLayout

Object
  |
  +--MovieClip
        |
        +--mx.core.UIObject
              |
              +--mx.core.UIComponent
                    |
                    +--mx.controls.CalendarLayout

class CalendarLayout
extends UIComponent

This class would handle the layout of the date grid in a month.

CalendarLayout can be extended to develop DateControls with either single month display control or side-by-side month displays.

Field Summary

__autoScale: Boolean

__cellHeight: Number

__cellWidth: Number

__colMargin: Number

__dateMargin: Number

__dayNames: Array

__dayToDateMargin: Number

__defaultCellHeight

default layout set maintaining original values for layout

__defaultCellWidth

__defaultColMargin

__defaultDateMargin

__defaultDayToDateMargin

__defaultLeftMargin

__defaultRightMargin

__disabledDays: Array

__disabledRanges: Array

__displayedMonth: Number

__displayedYear: Number

__dragSelectMode

__enabled: Boolean

__firstDayOfWeek: Number

__leftMargin: Number

__rightMargin: Number

__selectableRange: Object

__selectedDate: Date

__showToday: Boolean

modes for selectableRange normal: Object is passed and both rangeStart and rangeEnd are defined start: Object is passed and only rangeStart is defined end: Object is passed and only rangeEnd is defined date: a Date Object is passed Properties

_color: Object

styles

background_mc: MovieClip

backgroundDepth: Number

boundingBox: MovieClip

Children

className: String

dayBlock0label0: MovieClip

dayBlock6label0: MovieClip

dayBlockBaseDepth: Number

Depths in CalendarLayout

Variables variables

disRangeMode: Array

scroll details

hitAreaClip: MovieClip

labelBaseDepth: Number

nextYear: String

previousMonth: String

previousYear: String

rollOverDateDepth: Number

rollOverIndicator: MovieClip

selCell: TextField

selectedCell: String

selectedDateDepth: Number

selectedIndicator: MovieClip

selectedLabel: TextField

selRangeMode: Number

Other variables

showTodayDepth: Number

static

symbolName: String

Standard UIObject variables

static

symbolOwner: Object

todayIndicator: MovieClip

todaysLabelReference: TextField

Fields inherited from class mx.core.UIComponent

clipParameters, drawFocus, enabled, focusEnabled, focusManager, focusTextField, groupName, kStretch, mergedClipParameters, origBorderStyles, origBorderValues, popUp, symbolName, symbolOwner, tabEnabled, tabIndex, version

Fields inherited from class mx.core.UIObject

__height, __width, _color, _topmost, addEventListener, buildDepthTable, changeColorStyleInChildren, changeTextStyleInChildren, childrenCreated, className, clipParameters, color, createAccessibilityImplementation, createChildAtDepth, createEvent, ction, dispatchEvent, embedFonts, findNextAvailableDepth, fontFamily, fontSize, fontStyle, fontWeight, handleEvent, idNames, ignoreClassStyleDeclaration, initProperties, marginLeft, marginRight, methodTable, notifyStyleChangeInChildren, removeEventListener, setStyle, stylecache, styleName, symbolName, symbolOwner, textAlign, textColorList, textDecoration, textIndent, validateNow, version

Fields inherited from class MovieClip

_alpha, _currentframe, _droptarget, _focusrect, _framesloaded, _height, _lockroot, _name, _parent, _quality, _rotation, _soundbuftime, _target, _totalframes, _url, _visible, _width, _x, _xmouse, _xscale, _y, _ymouse, _yscale, enabled, focusEnabled, hitArea, tabChildren, tabEnabled, tabIndex, tooltipText, trackAsMenu, useHandCursor

Fields inherited from class Object

__proto__, constructor, prototype

Property Summary

autoScale: Boolean (read, write)

autoscale

cellHeight: Number (read, write)

cellHeight

cellWidth: Number (read, write)

cellWidth

colMargin: Number (read, write)

colMargin

dateMargin: Number (read, write)

dateMargin

dayNames: Array (read, write)

dayNames

dayToDateMargin: Number (read, write)

dayToDateMargin

disabledDays: Array (read, write)

disabledDays

disabledRanges: Array (read, write)

disabledRanges

displayedMonth: Number (read, write)

displayedMonth

displayedYear: Number (read, write)

displayedYear

dragSelectMode: Boolean (read, write)

enabled: Boolean (read, write)

enabled

firstDayOfWeek: Number (read, write)

first Day of week

leftMargin: Number (read, write)

leftMargin

rightMargin: Number (read, write)

rightMargin

selectableRange (read, write)

selectableRange

selectedDate: Date (read, write)

selectedDate

showToday: Boolean (read, write)

Properties showToday

Properties inherited from class mx.core.UIComponent

Properties inherited from class mx.core.UIObject

bottom, height, left, minHeight, minWidth, right, scaleX, scaleY, top, visible, width, x, y

Constructor

CalendarLayout ( )

Method Summary

checkDateValidity ( dt: Date ): Boolean

checking for valid dates, months and Years before setting them through API

checkMonthValidity ( m: Number ): Boolean

checkSelectedIndicator ( columnIndex: Number, selectCheck: Boolean ): Void

checkYearValidity ( y: Number ): Boolean

createChildren ( ): Void

A note about DayBlocks: dayBlock0..dayBlock6 are skins for the 7 grid columns.

dayBlockMouseMoveHandler ( )

dayBlockReleaseHandler ( ): Void

dayBlockRollOutHandler ( ): Void

dayBlockRollOverHandler ( ): Void

dayBlock press handler.

drawDayNames ( ): Void

Calendar logic drawing the days of week

getDayNames ( ): Array

getDisabledDays ( ): Array

getNumberOfDaysInMonth ( year: Number, month: Number ): Number

getOffsetOfMonth ( year: Number, month: Number ): Number

called from setSelectedMonthAndYear() to get an Offset of the starting day of the month

init ( Void ): Void

Overridden methods

invalidateStyle ( ): Void

called if just styles are changing so subclasses don't have to redraw everything

setAutoScale ( au: Boolean )

setCellHeight ( ce: Number )

setCellWidth ( cw: Number )

setColMargin ( cm: Number )

setDateMargin ( dtm: Number )

setDayNames ( dn: Array )

setDayToDateMargin ( dm: Number )

setDisabledDays ( d: Array )

setDisabledRanges ( drn: Array )

setDisplayedMonth ( mo: Number )

setDisplayedYear ( ye: Number )

setDragSelectMode ( ds: Boolean )

setEnabled ( f: Boolean )

setFirstDayOfWeek ( b: Number ): Void

setLeftMargin ( lm: Number )

setRightMargin ( rm: Number )

setSelectableRange ( srn )

setSelectedDate ( sd: Date )

setSelectedMonthAndYear ( newMonth: Number, newYear: Number ): Void

setShowToday ( n: Boolean )

setSize ( w: Number, h: Number, noEvent: Boolean )

size the object

setStyle ( n: String, val ): Void

set a style property.

stepDate ( deltaY: Number, deltaM: Number ): Void

Methods inherited from class mx.core.UIComponent

dispatchValueChangedEvent, enabledChanged, findFocusFromObject, findFocusInChildren, getFocus, getFocusManager, init, isParent, onKillFocus, onSetFocus, pressFocus, releaseFocus, setEnabled, setFocus, setVisible, size

Methods inherited from class mx.core.UIObject

__getTextFormat, _createChildren, _getTextFormat, cancelAllDoLaters, constructObject, createChildren, createClassObject, createEmptyObject, createLabel, createObject, createSkin, destroyObject, doLater, doLaterDispatcher, draw, drawRect, getClassStyleDeclaration, getMinHeight, getMinWidth, getSkinIDName, getStyle, getStyleName, init, initFromClipParameters, invalidate, invalidateStyle, mergeClipParameters, move, redraw, setColor, setMinHeight, setMinWidth, setSize, setSkin, setVisible, size

Methods inherited from class MovieClip

attachAudio, attachMovie, beginFill, beginGradientFill, clear, createEmptyMovieClip, createTextField, curveTo, duplicateMovieClip, endFill, getBounds, getBytesLoaded, getBytesTotal, getDepth, getInstanceAtDepth, getNextHighestDepth, getSWFVersion, getTextSnapshot, getURL, globalToLocal, gotoAndPlay, gotoAndStop, hitTest, lineStyle, lineTo, loadMovie, loadVariables, localToGlobal, moveTo, nextFrame, onData, onDragOut, onDragOver, onEnterFrame, onKeyDown, onKeyUp, onKillFocus, onLoad, onMouseDown, onMouseMove, onMouseUp, onPress, onRelease, onReleaseOutside, onRollOut, onRollOver, onSetFocus, onUnload, play, prevFrame, removeMovieClip, setMask, startDrag, stop, stopDrag, swapDepths, unloadMovie, valueOf

Methods inherited from class Object

addProperty, hasOwnProperty, isPropertyEnumerable, isPrototypeOf, registerClass, toLocaleString, toString, unwatch, valueOf, watch

Field Documentation

__autoScale

var __autoScale: Boolean

__cellHeight

var __cellHeight: Number

__cellWidth

var __cellWidth: Number

__colMargin

var __colMargin: Number

__dateMargin

var __dateMargin: Number

__dayNames

var __dayNames: Array

__dayToDateMargin

var __dayToDateMargin: Number

__defaultCellHeight

var __defaultCellHeight

default layout set maintaining original values for layout

__defaultCellWidth

var __defaultCellWidth

__defaultColMargin

var __defaultColMargin

__defaultDateMargin

var __defaultDateMargin

__defaultDayToDateMargin

var __defaultDayToDateMargin

__defaultLeftMargin

var __defaultLeftMargin

__defaultRightMargin

var __defaultRightMargin

__disabledDays

var __disabledDays: Array

__disabledRanges

var __disabledRanges: Array

__displayedMonth

var __displayedMonth: Number

__displayedYear

var __displayedYear: Number

__dragSelectMode

var __dragSelectMode

__enabled

var __enabled: Boolean

__firstDayOfWeek

var __firstDayOfWeek: Number

__leftMargin

var __leftMargin: Number

__rightMargin

var __rightMargin: Number

__selectableRange

var __selectableRange: Object

__selectedDate

var __selectedDate: Date

__showToday

var __showToday: Boolean

modes for selectableRange normal: Object is passed and both rangeStart and rangeEnd are defined start: Object is passed and only rangeStart is defined end: Object is passed and only rangeEnd is defined date: a Date Object is passed Properties

_color

var _color: Object

styles

background_mc

var background_mc: MovieClip

backgroundDepth

var backgroundDepth: Number

boundingBox

var boundingBox: MovieClip

Children

className

var className: String

dayBlock0label0

var dayBlock0label0: MovieClip

dayBlock6label0

var dayBlock6label0: MovieClip

dayBlockBaseDepth

var dayBlockBaseDepth: Number

Depths in CalendarLayout

defaultHeight

var defaultHeight

defaultWidth

var defaultWidth

Variables variables

disRangeMode

var disRangeMode: Array

ect

var ect

scroll details

hitAreaClip

var hitAreaClip: MovieClip

labelBaseDepth

var labelBaseDepth: Number

nextYear

var nextYear: String

previousMonth

var previousMonth: String

previousYear

var previousYear: String

rollOverDateDepth

var rollOverDateDepth: Number

rollOverIndicator

var rollOverIndicator: MovieClip

selCell

var selCell: TextField

selectedCell

var selectedCell: String

selectedDateDepth

var selectedDateDepth: Number

selectedIndicator

var selectedIndicator: MovieClip

selectedLabel

var selectedLabel: TextField

selRangeMode

var selRangeMode: Number

Other variables

showTodayDepth

var showTodayDepth: Number

symbolName

static var symbolName: String

Standard UIObject variables

symbolOwner

static var symbolOwner: Object

todayIndicator

var todayIndicator: MovieClip

todaysLabelReference

var todaysLabelReference: TextField

Property Documentation

autoScale

autoScale

: Boolean (read, write)

autoscale

cellHeight

cellHeight

: Number (read, write)

cellHeight

cellWidth

cellWidth

: Number (read, write)

cellWidth

colMargin

colMargin

: Number (read, write)

colMargin

dateMargin

dateMargin

: Number (read, write)

dateMargin

dayNames

dayNames

: Array (read, write)

dayNames

dayToDateMargin

dayToDateMargin

: Number (read, write)

dayToDateMargin

disabledDays

disabledDays

: Array (read, write)

disabledDays

disabledRanges

disabledRanges

: Array (read, write)

disabledRanges

displayedMonth

displayedMonth

: Number (read, write)

displayedMonth

displayedYear

displayedYear

: Number (read, write)

displayedYear

dragSelectMode

dragSelectMode

: Boolean (read, write)

enabled

enabled

: Boolean (read, write)

enabled

firstDayOfWeek

firstDayOfWeek

: Number (read, write)

first Day of week

leftMargin

leftMargin

: Number (read, write)

leftMargin

rightMargin

rightMargin

: Number (read, write)

rightMargin

selectableRange

selectableRange

(read, write)

selectableRange

selectedDate

selectedDate

: Date (read, write)

selectedDate

showToday

showToday

: Boolean (read, write)

Properties showToday

Constructor Documentation

CalendarLayout

function CalendarLayout

()

Method Documentation

checkDateValidity

function checkDateValidity

(dt: Date): Boolean

checking for valid dates, months and Years before setting them through API

checkMonthValidity

function checkMonthValidity

(m: Number): Boolean

checkSelectedIndicator

function checkSelectedIndicator

(columnIndex: Number,
selectCheck: Boolean): Void

checkYearValidity

function checkYearValidity

(y: Number): Boolean

createChildren

function createChildren

(): Void

A note about DayBlocks: dayBlock0..dayBlock6 are skins for the 7 grid columns.

They are dynamically created instances of the "DayBlock" symbol. Three additional properties are set when each dayBlock is created in createChildren(): columnIndex:Number (0-6) keeps track of where this dayBlock is in the grid selectedArray:Array 7 elements, one for each row selectedArray[rowIndex] is true if that row in the dayBlock is selected disabledArray:Array 7 elements, one for each row disabledArray[rowIndex] is true if that row in the dayBlock is disabled Additional properties are created dynamically to hold the skins for selected and disabled rows in the dayBlock: selectedSkin0..selectedSkin6 disabledSkin0..disabledSkin6

Overrides:: mx.core.UIObject.createChildren in class mx.core.UIObject

dayBlockMouseMoveHandler

function dayBlockMouseMoveHandler

()

dayBlockReleaseHandler

function dayBlockReleaseHandler

(): Void

dayBlockRollOutHandler

function dayBlockRollOutHandler

(): Void

dayBlockRollOverHandler

function dayBlockRollOverHandler

(): Void

dayBlock press handler.

Would be active on when the "dragSelectMode" is true

drawDayNames

function drawDayNames

(): Void

Calendar logic drawing the days of week

getDayNames

function getDayNames

(): Array

getDisabledDays

function getDisabledDays

(): Array

getNumberOfDaysInMonth

function getNumberOfDaysInMonth

(year: Number,
month: Number): Number

getOffsetOfMonth

function getOffsetOfMonth

(year: Number,
month: Number): Number

called from setSelectedMonthAndYear() to get an Offset of the starting day of the month

init

function init

(Void): Void

Overridden methods

Overrides:: mx.core.UIComponent.init in class mx.core.UIComponent

invalidateStyle

function invalidateStyle

(): Void

called if just styles are changing so subclasses don't have to redraw everything

Overrides:: mx.core.UIObject.invalidateStyle in class mx.core.UIObject

setAutoScale

function setAutoScale

(au: Boolean)

setCellHeight

function setCellHeight

(ce: Number)

setCellWidth

function setCellWidth

(cw: Number)

setColMargin

function setColMargin

(cm: Number)

setDateMargin

function setDateMargin

(dtm: Number)

setDayNames

function setDayNames

(dn: Array)

setDayToDateMargin

function setDayToDateMargin

(dm: Number)

setDisabledDays

function setDisabledDays

(d: Array)

setDisabledRanges

function setDisabledRanges

(drn: Array)

setDisplayedMonth

function setDisplayedMonth

(mo: Number)

setDisplayedYear

function setDisplayedYear

(ye: Number)

setDragSelectMode

function setDragSelectMode

(ds: Boolean)

setEnabled

function setEnabled

(f: Boolean)

Overrides:: mx.core.UIComponent.setEnabled in class mx.core.UIComponent

setFirstDayOfWeek

function setFirstDayOfWeek

(b: Number): Void

setLeftMargin

function setLeftMargin

(lm: Number)

setRightMargin

function setRightMargin

(rm: Number)

setSelectableRange

function setSelectableRange

(srn)

setSelectedDate

function setSelectedDate

(sd: Date)

setSelectedMonthAndYear

function setSelectedMonthAndYear

(newMonth: Number,
newYear: Number): Void

setShowToday

function setShowToday

(n: Boolean)

setSize

function setSize

(w: Number,
h: Number,
noEvent: Boolean)

size the object

Overrides:: mx.core.UIObject.setSize in class mx.core.UIObject

Parameters:

w		width of the object
h		height of the object
noEvent		if true, doesn't broadcast "resize" event

setStyle

function setStyle

(n: String,
val): Void

set a style property.

Causes lots of processing so use sparingly. actual implementation is in mx.styles.CSSSetStyle.as

Overrides:: mx.core.UIObject.setStyle in class mx.core.UIObject

Parameters:

n		String prop name of style property
val		Variant value new value for style

stepDate

function stepDate

(deltaY: Number,
deltaM: Number): Void

The documentation was generated from the following file:

CalendarLayout.as, Last Modified: 03.09.2003 02:54:46