Main Page | Packages | Class Tree | Index | Help

xp.controls

class DateSelector

MovieClip
  |
  +--xp.system.UIControl
        |
        +--xp.controls.DateSelector


class DateSelector
extends UIControl

Allows users to select one or more dates from a calendar


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public static
classInfo: Object
A static class information object

public
dayNames: Array
The day names array. Used in the calender header.

public
isSelectionRequired: Boolean
Is a selection required

public
monthNames: Array
The mont names strings array. Used on the date display.

public
selectOnKeyScroll: Boolean
Controls whether dates are selected as you scroll

public
styleClass: String
The name of the style class this instance will use.

public
tabStop: Boolean
All input controls are TabStops by default

Fields inherited from class xp.system.UIControl

__layout, allowDrop, autoLayout, bindingDefaultValue, bindingFormatter, bindingPath, bindingSource, bindingType, bindingValidator, border, causesValidation, classInfo, clickOnENTER, clickOnSPACE, container, context, data, disableAcceptButton, disableCancelButton, enableBGMouseEvents, enableDblClickEvent, enableKeyDownEvents, enableKeyEvents, enableKeyUpEvents, enableMouseWheelEvents, formatterOptions, horizontalAlignment, index, isBinding, itemId, logEnabled, parent, parentContainer, parentForm, percentageHeight, percentageWidth, styleClass, tabIndex, tabStop, tooltip, tree, verticalAlignment

Property Summary

public
displayedDay: Number (read, write)
The day number of the currently selcted date

public
displayedMonth: Number (read, write)
The monht number of the currently selcted date

public
displayedYear: Number (read, write)
The year number of the currently selcted date

public
firstDayOfWeek: Number (read, write)
The first day of a week. Can be eiether 0(Sunday) or 1(Monday)

public
selectedDate: Date (read, write)
The currently selected date

public
selectedDateFormat: String (read, write)
Format string for the selected date

public
showToday: Boolean (read, write)
Show the calender initially with todays date selected

Properties inherited from class xp.system.UIControl

alpha, autosize, background, backgroundVisible, bindings, borderBrush, borderRadius, borderShadow, borderStyle, borderThickness, bottom, dataSource, enableMouseEvents, focusManager, height, id, isEnabled, isFocused, isMouseOver, isPressed, isSelected, isValid, layout, left, margin, maxHeight, maxWidth, measuredHeight, measuredMinHeight, measuredMinWidth, measuredWidth, minHeight, minWidth, padding, readOnly, resources, right, styleName, top, triggers, visible, width, x, y

Constructor

public
DateSelector ( )
Constructor - This should not be called directly.


Method Summary

public
drawComponent ( ): Void
Layout the calender and header

public
getClass ( ): Function
Returns a reference to the components static class

public static
newInstance ( owner, instanceId, depth, initObj )
Creates a new Instance of this class

Methods inherited from class xp.system.UIControl

addBinding, addBindings, addEventListener, addPropertyTrigger, applyStyle, beginDeferUpdate, canUpdate, centerContent, checkState, containsFocus, destroy, destroyObject, drawFocus, endDeferUpdate, findFocusFromObject, findFocusInChildren, getBinding, getBounds, getCenter, getClass, getFocus, getFocusManager, getFocusRect, getLocation, getPropertyValue, getSize, getStateName, getTrigger, globalToLocalPoint, invalidate, invalidateLayout, invalidateSize, invalidateSizeAndLayout, invalidChild, isChild, isMouseDirectlyOver, isParent, localToGlobalPoint, localToLocalPoint, measure, mouseWheel, move, onChildFocus, onKillFocus, onSetFocus, processEnterKey, processEscapeKey, processTabKey, redraw, refresh, removeEventListener, routeEvent, setBounds, setFocus, setLocation, setPropertyValue, setSize, setValueChanged, update, validate



Field Documentation

classInfo

public static var classInfo: Object
A static class information object

Every class has an associated classInfo object that holds the version and other static information. The classInfo can be accessed either directly by referencing the static class or by calling getClass() on any class instance.

dayNames

public var dayNames: Array
The day names array. Used in the calender header.

isSelectionRequired

public var isSelectionRequired: Boolean
Is a selection required

If this is true a date can only be unselected by selecting another date

monthNames

public var monthNames: Array
The mont names strings array. Used on the date display.

selectOnKeyScroll

public var selectOnKeyScroll: Boolean
Controls whether dates are selected as you scroll

If this is true then as u navigate with the keyboard the cell is automatically selected

styleClass

public var styleClass: String
The name of the style class this instance will use.

tabStop

public var tabStop: Boolean
All input controls are TabStops by default


Property Documentation

displayedDay

public displayedDay: Number (read, write)
The day number of the currently selcted date

displayedMonth

public displayedMonth: Number (read, write)
The monht number of the currently selcted date

displayedYear

public displayedYear: Number (read, write)
The year number of the currently selcted date

firstDayOfWeek

public firstDayOfWeek: Number (read, write)
The first day of a week. Can be eiether 0(Sunday) or 1(Monday)

selectedDate

public selectedDate: Date (read, write)
The currently selected date

selectedDateFormat

public selectedDateFormat: String (read, write)
Format string for the selected date

showToday

public showToday: Boolean (read, write)
Show the calender initially with todays date selected


Constructor Documentation

DateSelector

public function DateSelector()
Constructor - This should not be called directly.

If you want to dynamically create a new instance of a control use its static newInstance method


Method Documentation

drawComponent

public function drawComponent(): Void
Layout the calender and header

Overrides:

getClass

public function getClass(): Function
Returns a reference to the components static class

Overrides:

newInstance

public static function newInstance(owner,
 instanceId,
 depth,
 initObj)
Creates a new Instance of this class

Creates an instance of a component at runtime. You need to use the import statement and specify the class package name before calling this method. In addition, the component must be in the FLA file’s library.

Parameters:
owner
A reference to the movie clip or object that will contains the new Instance.
instanceId
A string indicating the instance name of the new instance.(optional)
depth
A number indicating the depth of the new instance.(optional)
initObj
An object containing initialization properties for the new instance.(optional)
Returns:
A object that is an instance of the specified class.


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc