Class SS.control.calendar

Calendar Control
Defined in: SS.control.calendar.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	SS.control.calendar()

Field Summary
Field Attributes	Field Name and Description
<private>	_f Default format for serializing the date.
<private>	_i Flag to indicate if the calendar has previously been reneders on the current page.
<private>	_idb Id of the table body element inside the calendar.
<private>	_idh Id of the table header element inside the calendar.
<private>	_idt Id of the table element that holds the calendar.
	css Classname for entire calendar.
	css_daysmonth Classname for all the dates in the calendar.
	css_daysmonthlast Classname for the dates that fall into the previous visible month.
	css_daysmonthnext Classname for the dates that fall into the following visible month.
	css_disabled Classname for dates which have been marked as disabled.
	css_navigate Classname for the the previous (<<) and next (>>) month navigation buttons.
	css_selecteddate Classname for the currently selected date.
	css_title Classname for calendar title, typically the Month Year display at the top of the calendar.
	css_titledays Classname for days of the week in the calendar.
	css_weekend Classname for the weekend columns.
	datemax Defines a maximum selectable date range.
	datemin Defines a minimum selectable date range.
	dayformat Format to output the day labels in.
	height Calendar height.
	id Identifier of the calendar control.
	keys Enable selection of the date by arrow keys as long as the calendar is linked to a input field.
	linkto Id of element that will hold the selected date.
	linktoformat Date format used to store the selected calendar date in text form in the chosen linkto field.
	localecode Locale code.
	monthformat Format to output the month labels in.
	onchange Function called or evaluated {String} whenever the calendar date is changed.
	onvisiblemonthchange Function called or evaluated {String} whenever the visisble calendar month changes.
	scroll Enable the visible month to be changed by the scroll button on the mouse.
	selecteddate Currently selected date.
	sevenweek Seven or six week calendar display.
	sundaylast Boolean flag to determin position of Sunday on the calendar.
	visible Flag to indicate whether or not the calendar is currently visible.
	visiblemonth Month being displayed on the calendar
	width Calendar width.

Method Summary
Method Attributes	Method Name and Description
	dayChange(d) Changes the selected date by d days
	display(d) Change the visibilty of the calendar.
	hide() Hides the calendar.
	render() Renders the calendar on the page.
	setDate(d, e) Sets the selected date and changes the visible month to reflect it.
	setLocaleCode(ul)
	show() Displays the calendar.
	visiblemonthchange(d, e) Changes the visible month by d months

Class Detail

SS.control.calendar()

Field Detail

<private> _f

Default format for serializing the date. Default = "yyyy/MM/dd".

<private> _i

Flag to indicate if the calendar has previously been reneders on the current page.

<private> _idb

Id of the table body element inside the calendar.

<private> _idh

Id of the table header element inside the calendar.

<private> _idt

Id of the table element that holds the calendar.

css

Classname for entire calendar. Defalut = "SS_control_calendar".

css_daysmonth

Classname for all the dates in the calendar. Defalut = "SS_control_calendar_daysmonth".

css_daysmonthlast

Classname for the dates that fall into the previous visible month. Defalut = "SS_control_calendar_daysmonthlast".

css_daysmonthnext

Classname for the dates that fall into the following visible month. Defalut = "SS_control_calendar_daysmonthnext".

css_disabled

Classname for dates which have been marked as disabled. Defalut = "SS_control_calendar_disabled".

css_navigate

Classname for the the previous (<<) and next (>>) month navigation buttons. Defalut = "SS_control_calendar_navigate".

css_selecteddate

Classname for the currently selected date. Defalut = "SS_control_calendar_selecteddate".

css_title

Classname for calendar title, typically the Month Year display at the top of the calendar. Defalut = "SS_control_calendar_title".

css_titledays

Classname for days of the week in the calendar. Defalut = "SS_control_calendar_titledays".

css_weekend

Classname for the weekend columns. Defalut = "SS_control_calendar_weekend".

datemax

Defines a maximum selectable date range. Default = no limit Default = "".

datemin

Defines a minimum selectable date range. Default = no limit Default = "".

dayformat

Format to output the day labels in. Values: [1,2,3,full]. Default = "1".

height

Calendar height. Overrides and style settings to set the height of the calendar.

Identifier of the calendar control.

keys

Enable selection of the date by arrow keys as long as the calendar is linked to a input field. Default = false.

linkto

Id of element that will hold the selected date. Typically this will be either a text or hidden field. Changing the value of the linked to field is automatically reflected in the calendar.

linktoformat

Date format used to store the selected calendar date in text form in the chosen linkto field. Default = "yyyy/MM/dd". a text or hidden field. Changing the value of the linked to field is automatically reflected in the calendar.

localecode

Locale code. 2 character country code which determins the date format used. See ISO 3166-1 alpha-2.

monthformat

Format to output the month labels in. Values: [1,2,3,full]. Default = "full".

onchange

Function called or evaluated {String} whenever the calendar date is changed.

onvisiblemonthchange

Function called or evaluated {String} whenever the visisble calendar month changes.

scroll

Enable the visible month to be changed by the scroll button on the mouse. Default = true.

selecteddate

Currently selected date.

sevenweek

Seven or six week calendar display. false = 6 week display, true = 7 week display. Default = false.

sundaylast

Boolean flag to determin position of Sunday on the calendar. false = Sunday first day of week, true = Sunday last day of week. Default = true.

visible

Flag to indicate whether or not the calendar is currently visible. Overrides style="display:none;" rule on initial render. Default = true.

visiblemonth

Month being displayed on the calendar

width

Calendar width. Overrides and style settings to set the width of the calendar.

Method Detail

dayChange(d)

Changes the selected date by d days

Parameters:
{Integer} d: Changes the selected date by d days.

Returns:: null

display(d)

Change the visibilty of the calendar.

Parameters:
{Boolean} d: Display flag. True = Visible, False = Hidden.

Returns:: null

hide()

Hides the calendar. See SS.control.calendar.display.

Returns:: null

render()

Renders the calendar on the page.

Returns:: null

setDate(d, e)

Sets the selected date and changes the visible month to reflect it.

Parameters:
{Date} d: Date to set as the selected date.
{Event} e

setLocaleCode(ul)

Parameters:
{String} ul: Locale code. 2 character country code which determins the
date format used. See ISO 3166-1 alpha-2.

show()

Displays the calendar. See SS.control.calendar.display.

Returns:: null

visiblemonthchange(d, e)

Changes the visible month by d months

Parameters:
{Integer} d: Number of months to change the visible month by
{Event} e

Returns:: null

Classes

Classes

Class SS.control.calendar