Class: Calendar

RichFaces.ui. Calendar

new Calendar(componentId, locale, options, markups)

Backing object for rich:calendar
Parameters:
Name Type Description
componentId string component id
locale string calendar locale
options string
markups
Source:

Extends

Members

name :string

Component name.
Type:
  • string
Inherited From:
Source:

Methods

attachToDom(source) → {DOMElement}

Attach component object to DOM element by component id, DOM element or jQuery object and returns the element Its required for the client side API calls and to clean up after ajax request or document unload by calling destroy method
Parameters:
Name Type Description
source string | DOMElement | jQuery component id, DOM element or DOM elements wrapped by jQuery
Inherited From:
Source:
Returns:
Type
DOMElement

destroy()

Destroy method. Will be called before remove component from the page
Inherited From:
Source:

detach(source)

Detach component object from DOM element by component id, DOM element or jQuery object
Parameters:
Name Type Description
source string | DOMElement | jQuery component id, DOM element or DOM elements wrapped by jQuery
Inherited From:
Source:

focus()

Focus the input element
Source:

getCurrentMonth() → {int}

Get the number of the current month
Source:
Returns:
number of current month, 0-based
Type
int

getCurrentYear() → {int}

Get the current year
Source:
Returns:
current year
Type
int

getEventElement() → {string}

Method returns element's id for event handlers binding. Event API calls this method when binding by component object as selector was used.
Inherited From:
Source:
Returns:
Type
string

getValue() → {date}

Get the current date value
Source:
Returns:
current date value
Type
date

getValueAsString(patternopt) → {string}

Get the current date value as string, formatted by the given pattern
Parameters:
Name Type Attributes Description
pattern string <optional>
date pattern
Source:
Returns:
current value
Type
string

hideDateEditor()

Hide the date editor popup
Source:

hidePopup()

Hide the popup
Source:

hideTimeEditor()

Hide the time editor popup
Source:

invokeEvent(eventType, element, event, data) → {boolean}

Invokes event on on the DOM element
Parameters:
Name Type Description
eventType string event type, e.g. "click"
element DOMElement DOM element object
event Event jQuery Event
data Object additional data used for event handler
Inherited From:
Source:
Returns:
true if an event is successfully invoked
Type
boolean

resetValue()

Clear the current date value
Source:

showDateEditor()

Show the date editor popup
Source:

showPopup()

Show the popup
Source:

showSelectedDate()

Show the month containing the selected date
Source:

showTimeEditor()

Show the time editor popup
Source:

switchPopup()

Switch the state of the popup
Source:

today()

Select today's date
Source:

toString() → {string}

Method for converting object to string
Inherited From:
Source:
Returns:
Type
string