dhx.ui.calendar
Type: Component
File:
Based on:
dhx.MouseEvents
,
dhx.Settings
,
dhx.EventSystem
,
dhx.Movable
,
dhx.ui.view
,
dhx.ui.baseview
,
dhx.Settings
,
dhx.Destruction
,
dhx.BaseBind
Included in:
Methods
adjust
- adjusts the component to the size of the outer parent
HTML
container
attachEvent
- attaches custom handler to inner event
bind
- binds components
blockEvent
- blocks event triggering
callEvent
- calls inner event
define
- sets configuration property or a hash of properties
destructor
- destructs an object
detachEvent
- detaches custom code from handler
getNode
- returns main html container of view
getParent
- returns parent object of current view
getSelectedDate
- returns currently selected date
getValue
- returns the current value of control
getVisibleDate
- retuns visible date: in the general case, the selected date or the first day of the month if the currently selected date is not visible
hasEvent
- checks whether a component has an event
hide
- hides view
isVisible
- returns true if current view is visible
mapEvent
- routes events from one object to another
refresh
- repaints input
render
- renders an object
resize
- adjusts view to the new size
selectDate
- selects date
setValue
- sets a new value for a control
show
- makes view visible
showCalendar
- shows calendar (and selects date if it is defined)
unblockEvent
- enables event triggering
Events
onaftermonthchange
- called after month in selector is changed.
onafterrender
- called after the rendering of calendar is complete.
onbeforecontextmenu
- fires before context menu was called in the item area
onbeforemonthchange
- triggered immediately before month in selector is changed.
onbeforerender
- triggered immediately before rendering of calendar is started.
onchange
- fired when a user changes month, year or time in selector.
ondateselect
- fired when a user selected a date.
onitemclick
- fires when item was clicked
onitemdblclick
- fires when item was double-clicked
onmousemove
- fires when mouse was pointed over item
onmousemoving
- fires when mouse was moved over component
onmouseout
- fires when mouse was moved out from item
Properties
animate
- defines animation on view change (object with direction, type and subtype properties) or disables animation (false)
calendarDateFormat
- date format (%Y-%m-%d)
calendarDayHeader
- format for week header (%d)
calendarDay
- day format (%d)
calendarHeader
- format for header (%F %Y)
calendarMonthHeader
- month format in header (%F %Y)
calendarWeekHeader
- label for column with weeks numbers (W#)
calendarWeek
- format for week number (%W)
cellHeight
- height of the cell with day (36)
container
- html container or its id where view needs initializing
css
- class name for view container
date
- Date() object that specifies the initial date of the calendar (particularly month).
gravity
- view gravity (1 by default)
height
- view height
hidden
- sets whether a view will be hidden initially
hourEnd
- the last hour in a hour select
hourFormat
- hour format (%H)
hourStart
- the first hour in a hour select (8)
id
- view id
minuteStep
- step in minutes selector (15)
monthHeaderHeight
- the height of month header (40 by default, property should be changed in css too)
move
- makes view movable
navigation
- enables/disables month navigation in header - the possibility to change months (true)
on
- allows to attach custom handlers to inner events of the component
scroll
- enables scrolling
selectedCss
- the name of a css class that will be applied to the control initialy.
selectedDateClassName
- class name for the selected date (dhx_cal_selected_day)
skipEmptyWeeks
- enables/disables displaying empty weeks (true)
startOnMonday
- defines whether week is started on monday
timeSelectHeight
- the height of area with time selector (32 by default, property should be changed in css too)
timeSelect
- enables/disables time selector (false)
weekHeaderHeight
- the height of week header (20 by default, property should be changed in css too)
weekHeader
- enables/disables additional header with week days (false)
weekNumber
- enables/disables additional left column with weeks' numbers (false)
width
- view width