\Hazaar\View\Widgets
Calendar

Calendar widget class

Tags

Since

1.1

Summary
Methods Properties Constants
No constants
Properties
Inherited
$element
$element
Inherited
$name
$name
Inherited
$script
$script
Methods
__construct()
__construct($name)

Parameters

$name

No description

backText()
backText($value) : \\Hazaar\\Widget\\Calendar

Sets the tooltip text displayed when the mouse cursor is over the back navigation button.

clearString()
clearString($value) : \\Hazaar\\Widget\\Calendar

Sets the ‘Clear’ string displayed when the ‘showFooter’ property is true.

columnHeaderHeight()
columnHeaderHeight($value) : \\Hazaar\\Widget\\Calendar

Sets the Calendar colomn header’s height. In the column header are displayed the calendar day names.

culture()
culture($value) : \\Hazaar\\Widget\\Calendar

Sets the jqxCalendar’s culture. The culture settings are contained within a file with the language code appended to the name, e.g. jquery.glob.de-DE.js for German. To set the culture, you need to include the jquery.glob.de-DE.js and set the culture property to the culture’s name, e.g. ‘de-DE’.

dayNameFormat()
dayNameFormat($value) : \\Hazaar\\Widget\\Calendar

Sets the name format of days of the week. Possible values: ‘default’, ‘shortest’, ‘firstTwoLetters’, ‘firstLetter’, ‘full’.

disabled()
disabled($value) : \\Hazaar\\Widget\\Calendar

Disables (true) or enables (false) the calendar. Can be set when initialising (first creating) the calendar.

Parameters

$value\Hazaar\View\Widgets\bool

The initial state to set

Returns

\\Hazaar\\Widget\\Calendar
enableAutoNavigation()
enableAutoNavigation($value) : \\Hazaar\\Widget\\Calendar

Sets a value indicating whether the auto navigation is enabled. When this property is true, click on other month date will automatically navigate to the previous or next month.

enableFastNavigation()
enableFastNavigation($value) : \\Hazaar\\Widget\\Calendar

Sets a value indicating whether the fast navigation is enabled.

enableHover()
enableHover($value) : \\Hazaar\\Widget\\Calendar

Sets a value indicating whether the hover state is enabled. The hover state is activated when the mouse cursor is over a calendar cell. The hover state is automatically disabled when the calendar is displayed in touch devices.

enableOtherMonthDays()
enableOtherMonthDays($value) : \\Hazaar\\Widget\\Calendar

Sets a value indicating whether the other month days are enabled.

enableTooltips()
enableTooltips($value) : \\Hazaar\\Widget\\Calendar

Sets a value indicating whether the tool tips are enabled.

enableViews()
enableViews($value) : \\Hazaar\\Widget\\Calendar

Determines whether switching between month, year and decade views is enabled.

enableWeekend()
enableWeekend($value) : \\Hazaar\\Widget\\Calendar

Sets a value indicating whether weekend persists its view state.

firstDayOfWeek()
firstDayOfWeek($value) : \\Hazaar\\Widget\\Calendar

Sets which day to display in the first day column. By default the calendar displays ‘Sunday’ as first day.

forwardText()
forwardText($value) : \\Hazaar\\Widget\\Calendar

Sets the tooltip text displayed when the mouse cursor is over the forward navigation button.

getDate()
getDate() : \\Hazaar\\Widget\\Calendar

COMMENT

getDateObject()
getDateObject($value, $encap = false)

Parameters

$value

No description

$encap

No description

getMaxDate()
getMaxDate() : \\Hazaar\\Widget\\Calendar

COMMENT

getMinDate()
getMinDate() : \\Hazaar\\Widget\\Calendar

COMMENT

getRange()
getRange() : \\Hazaar\\Widget\\Calendar

COMMENT

maxDate()
maxDate($value) : \\Hazaar\\Widget\\Calendar

Represents the maximum navigation date.

minDate()
minDate($value) : \\Hazaar\\Widget\\Calendar

Represents the minimum navigation date.

Parameters

$value\Hazaar\Date

COMMENT

Returns

\\Hazaar\\Widget\\Calendar
navigateBackward()
navigateBackward() : \\Hazaar\\Widget\\Calendar

COMMENT

navigateForward()
navigateForward() : \\Hazaar\\Widget\\Calendar

COMMENT

navigationDelay()
navigationDelay($value) : \\Hazaar\\Widget\\Calendar

Determines the animation delay between switching views.

onBackButtonClick()
onBackButtonClick($code) : \\Hazaar\\Widget\\Calendar

Execute JavaScript when the calendar back button is clicked

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Calendar
onChange()
onChange($code) : \\Hazaar\\Widget\\Calendar

Execute JavaScript when the calendar value changes

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Calendar
onNextButtonClick()
onNextButtonClick($code) : \\Hazaar\\Widget\\Calendar

Execute JavaScript when the calendar next button is clicked

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Calendar
onViewChange()
onViewChange($code) : \\Hazaar\\Widget\\Calendar

Execute JavaScript when the calendar view changes

Parameters

$codestring

The code to execute when the event is triggered.

Returns

\\Hazaar\\Widget\\Calendar
readOnly()
readOnly($value) : \\Hazaar\\Widget\\Calendar

Sets the calendar in read only state.

refresh()
refresh() : \\Hazaar\\Widget\\Calendar

COMMENT

rowHeaderWidth()
rowHeaderWidth($value) : \\Hazaar\\Widget\\Calendar

Sets the row header width.

selectionMode()
selectionMode($value) : \\Hazaar\\Widget\\Calendar

Sets the selection mode. The possible values are: ‘none’, ‘default’ and ‘range’.

setDate()
setDate($value) : \\Hazaar\\Widget\\Calendar

COMMENT

Parameters

$valuemixed

The date to set as either a string or \Hazaar\Date object.

Returns

\\Hazaar\\Widget\\Calendar
setMaxDate()
setMaxDate($value) : \\Hazaar\\Widget\\Calendar

COMMENT

Parameters

$valuemixed

The max date to set as either a string or \Hazaar\Date object.

Returns

\\Hazaar\\Widget\\Calendar
setMinDate()
setMinDate($value) : \\Hazaar\\Widget\\Calendar

COMMENT

Parameters

$valuemixed

The min date to set as either a string or \Hazaar\Date object.

Returns

\\Hazaar\\Widget\\Calendar
setRange()
setRange($start, $end) : \\Hazaar\\Widget\\Calendar

COMMENT

Parameters

$start

No description

$end

No description

Returns

\\Hazaar\\Widget\\Calendar
showDayNames()
showDayNames($value) : \\Hazaar\\Widget\\Calendar

Sets a value whether the day names are displayed. By default, the day names are displayed.

showFooter()
showFooter($value) : \\Hazaar\\Widget\\Calendar

Sets a value indicating whether the calendar’s footer is displayed.

showOtherMonthDays()
showOtherMonthDays($value) : \\Hazaar\\Widget\\Calendar

Sets a value whether the other month days are displayed.

showWeekNumbers()
showWeekNumbers($value) : \\Hazaar\\Widget\\Calendar

Sets a value whether the week`s numbers are displayed.

specialDates()
specialDates($value) : \\Hazaar\\Widget\\Calendar

Add a special date to the Calendar.

stepMonths()
stepMonths($value) : \\Hazaar\\Widget\\Calendar

Represents the calendar`s navigation step when the left or right navigation button is clicked.

titleFormat()
titleFormat($value) : \\Hazaar\\Widget\\Calendar

Sets the title format for the title section. Possible values:

  • “d”-the day of the month;
  • “dd”-the day of the month;
  • “ddd”-the abbreviated name of the day of the week;
  • “dddd”- the full name of the day of the week;
  • “h”-the hour, using a 12-hour clock from 1 to 12;
  • “hh”-the hour, using a 12-hour clock from 01 to 12;
  • “H”-the hour, using a 24-hour clock from 0 to 23;
  • “HH”- the hour, using a 24-hour clock from 00 to 23;
  • “m”-the minute, from 0 through 59;
  • “mm”-the minutes,from 00 though59;
  • “M”- the month, from 1 through 12;
  • “MM”- the month, from 01 through 12;
  • MMM”-the abbreviated name of the month;
  • MMMM”-the full name of the month;
  • “s”-the second, from 0 through 59;
  • “ss”-the second, from 00 through 59;
  • “t”- the first character of the AM/PM designator;
  • “tt”-the AM/PM designator;
  • “y”- the year, from 0 to 99;
  • “yy”- the year, from 00 to 99;
  • “yyy”-the year, with a minimum of three digits;
  • “yyyy”-the year as a four-digit number;
  • “yyyyy”-the year as a four-digit number.

titleHeight()
titleHeight($value) : \\Hazaar\\Widget\\Calendar

Sets the title height where the navigation arrows are displayed.

todayString()
todayString($value) : \\Hazaar\\Widget\\Calendar

Sets the ‘Today’ string displayed when the ‘showFooter’ property is true.

value()
value($value) : \\Hazaar\\Widget\\Calendar

Sets the Calendar’s value.