inputCalendar (Tomahawk Core Tag library documentation)

Overview

Library

Tag

Help

FRAMES NO FRAMES

Tomahawk tag library.
Tag inputCalendar

Provides a calendar. The calendar can be "inline", or a button can be rendered that displays the calendar in a "popup window" when clicked. Javascript is required for the popup window.

The two forms of calendar are unfortunately not well integrated; this component is effectively two components that happen to use the same component class. Some attributes on the component are applicable only to the inline form while others are applicable only to the popup form.

The appearance of the inline calendar can be controlled via attributes such as currentDayCellClass, dayCellClass, weekRowClass, monthYearRowClass. Attributes "styleLocation", "javascriptLocation", "imageLocation" and all attributes starting with "popup" have no effect on an inline calendar.

The appearance of the popup calendar can be controlled via attributes popupTheme, styleLocation, javascriptLocation and imageLocation:

popupTheme: When styleLocation is not overridden then this selects one of the built-in themes ("WH" or "DB"); the default is "DB". This also selects the prefix used for the names of style classes attached to generated dom elements; all style names are of form "jscalendar-{popupTheme}-*".
styleLocation: specifies the URL of a directory in which a "theme.css" file exists. A reference to this theme.css file will automatically be output. Specifying "none" as the location prevents the generation of this stylesheet reference; it is assumed that the necessary style rules will be loaded via some other mechanism. Defaults to a reference to a location within the tomahawk jarfile which varies based on popupTheme.
javascriptLocation: specifies the URL of a directory in which all the necessary script files can be found. A reference to scripts "prototype.js", "date.js" and "popcalendar.js" will automatically be output. Specifying "none" prevents generation of these references; it is assumed that the necessary javascript functions will be loaded via some other mechanism. Defaults to a reference to a location within the tomahawk jarfile.
imageLocation: specifies the URL of a directory in which all the necessary icons are defined. Defaults to a reference to a location within the tomahawk jarfile which varies depending on popupTheme.

Other styling attributes (eg dayCellClass, weekRowClass) are ignored for the popup calendar.

Unless otherwise specified, all attributes accept static values or EL expressions.

Tag Information
Tag Class	org.apache.myfaces.custom.calendar.HtmlInputCalendarTag
TagExtraInfo Class	None
Body Content	JSP
Display Name	None

Attributes
Name	Required	Request-time	Type	Description
dateBusinessConverter	false	false	`java.lang.String`	Indicate an object used as a bridge between the java.util.Date instance used by this component internally and the value object used on the bean, referred as a "business" value. If the value is literal, look for the mentioned class instance, create a new instance and assign to the component property. If it the value a EL Expression, set the expression to the component property.
monthYearRowClass	false	false	`java.lang.String`	CSS class to be used on the TR element for the header-row showing month and year.
weekRowClass	false	false	`java.lang.String`	CSS class to be used on the TR element for the header-row showing the week-days.
dayCellClass	false	false	`java.lang.String`	CSS class to be used for the TD element containing a day days.
currentDayCellClass	false	false	`java.lang.String`	CSS class to be used for the TD element of the currently selected date.
popupLeft	false	false	`java.lang.String`	Render the input-calendar left of the button, not right like normally done.
renderAsPopup	false	false	`java.lang.String`	Render the input-calendar as a java-script popup on client.
addResources	false	false	`java.lang.String`	Automatically add the input-calendar scripts and css files to the header - set that to false to provide the scripts yourself.
popupButtonString	false	false	`java.lang.String`	Defines the string displayed on the button which leads to the calendar-popup-window (... by default).
popupButtonStyle	false	false	`java.lang.String`	Defines the css style for the button which leads to the calendar-popup-window.
popupButtonStyleClass	false	false	`java.lang.String`	Defines the css style class for the button which leads to the calendar-popup-window.
renderPopupButtonAsImage	false	false	`java.lang.String`	If true, renders a calendar icon instead of the button to pop up the calendar.
popupDateFormat	false	false	`java.lang.String`	Defines the date format used by the java-script popup on client.
popupGotoString	false	false	`java.lang.String`	Set the string for "Go To Current Month"
popupTodayString	false	false	`java.lang.String`	Set the string for "Today is"
popupTodayDateFormat	false	false	`java.lang.String`	Defines the date format used by the java-script popup on client for the today-is string.
popupWeekString	false	false	`java.lang.String`	Set the string for "Wk"
popupScrollLeftMessage	false	false	`java.lang.String`	Set the string for scrolling to the left.
popupScrollRightMessage	false	false	`java.lang.String`	Set the string for scrolling to the right.
popupSelectMonthMessage	false	false	`java.lang.String`	Set the string for "Click to select a month".
popupSelectYearMessage	false	false	`java.lang.String`	Set the string for "Click to select a year".
popupSelectDateMessage	false	false	`java.lang.String`	Set the string for "Select [date] as date" (do not replace [date], it will be replaced by the current date).
popupTheme	false	false	`java.lang.String`	Set the theme-prefix for this component.
popupButtonImageUrl	false	false	`java.lang.String`	Url to the image for this popupButton.
helpText	false	false	`java.lang.String`	The text that will be rendered in the field - helping the user to find the right format to enter into the field.
popupSelectMode	false	false	`java.lang.String`	May be "day", "week", "month" or "none": day (default): allow the user to select a day. week: only allow the user to select a week. month: only allow the user to select a month. none: equivalent to "readonly".
enabledOnUserRole	false	false	`java.lang.String`	If user is in given role, this component will be rendered normally. If not, no hyperlink is rendered but all nested tags (=body) are rendered.
visibleOnUserRole	false	false	`java.lang.String`	If user is in given role, this component will be rendered normally. If not, nothing is rendered and the body of this tag will be skipped.
javascriptLocation	false	false	`java.lang.String`	An alternate location to find javascript resources. If no values is specified, javascript will be loaded from the resources directory using AddResource and ExtensionsFilter.
imageLocation	false	false	`java.lang.String`	An alternate location to find image resources. If no values is specified, images will be loaded from the resources directory using AddResource and ExtensionsFilter.
styleLocation	false	false	`java.lang.String`	An alternate location to find stylesheet resources. If no values is specified, stylesheets will be loaded from the resources directory using AddResource and ExtensionsFilter.
align	false	false	`java.lang.String`	HTML: Specifies the horizontal alignment of this element. Deprecated in HTML 4.01.
disabledOnClientSide	false	false	`java.lang.String`	If true the input is rendered disabled on the client side and a hidden input is used to actualy submit his value back to the server.
autocomplete	false	false	`java.lang.String`	Non HTML standard attribute to disable browser's autocomplete function.
displayValueOnly	false	false	`java.lang.String`	If true, renders only the value of the component, but no input widget. Default is false.
displayValueOnlyStyle	false	false	`java.lang.String`	Style used when displayValueOnly is true.
displayValueOnlyStyleClass	false	false	`java.lang.String`	Style class used when displayValueOnly is true.
forceId	false	false	`java.lang.String`	If true, this component will force the use of the specified id when rendering.
forceIdIndex	false	false	`java.lang.String`	If false, this component will not append a '[n]' suffix (where 'n' is the row index) to components that are contained within a "list." This value will be true by default and the value will be ignored if the value of forceId is false (or not specified.)
datafld	false	false	`java.lang.String`	Reserved for future use.
datasrc	false	false	`java.lang.String`	Reserved for future use.
dataformatas	false	false	`java.lang.String`	Reserved for future use.
maxlength	false	false	`java.lang.String`	HTML: The maximum number of characters allowed to be entered.
size	false	false	`java.lang.String`	HTML: The initial width of this control, in characters.
style	false	false	`java.lang.String`	HTML: CSS styling instructions.
styleClass	false	false	`java.lang.String`	The CSS class for this element. Corresponds to the HTML 'class' attribute.
alt	false	false	`java.lang.String`	HTML: Specifies alternative text that can be used by a browser that can't show this element.
tabindex	false	false	`java.lang.String`	HTML: Specifies the position of this element within the tab order of the document.
onblur	false	false	`java.lang.String`	HTML: Specifies a script to be invoked when the element loses focus.
onfocus	false	false	`java.lang.String`	HTML: Specifies a script to be invoked when the element receives focus.
accesskey	false	false	`java.lang.String`	HTML: Sets the access key for this element.
onclick	false	false	`java.lang.String`	HTML: Script to be invoked when the element is clicked.
ondblclick	false	false	`java.lang.String`	HTML: Script to be invoked when the element is double-clicked.
onkeydown	false	false	`java.lang.String`	HTML: Script to be invoked when a key is pressed down over this element.
onkeypress	false	false	`java.lang.String`	HTML: Script to be invoked when a key is pressed over this element.
onkeyup	false	false	`java.lang.String`	HTML: Script to be invoked when a key is released over this element.
onmousedown	false	false	`java.lang.String`	HTML: Script to be invoked when the pointing device is pressed over this element.
onmousemove	false	false	`java.lang.String`	HTML: Script to be invoked when the pointing device is moved while it is in this element.
onmouseout	false	false	`java.lang.String`	HTML: Script to be invoked when the pointing device is moves out of this element.
onmouseover	false	false	`java.lang.String`	HTML: Script to be invoked when the pointing device is moved into this element.
onmouseup	false	false	`java.lang.String`	HTML: Script to be invoked when the pointing device is released over this element.
onchange	false	false	`java.lang.String`	HTML: Specifies a script to be invoked when the element is modified.
onselect	false	false	`java.lang.String`	HTML: Specifies a script to be invoked when the element is selected.
dir	false	false	`java.lang.String`	HTML: The direction of text display, either 'ltr' (left-to-right) or 'rtl' (right-to-left).
lang	false	false	`java.lang.String`	HTML: The base language of this document.
title	false	false	`java.lang.String`	HTML: An advisory title for this element. Often used by the user agent as a tooltip.
disabled	false	false	`java.lang.String`	HTML: When true, this element cannot receive focus.
readonly	false	false	`java.lang.String`	HTML: When true, indicates that this component cannot be modified by the user. The element may receive focus unless it has also been disabled.
validator	false	false	`java.lang.String`	A method binding EL expression, accepting FacesContext, UIComponent, and Object parameters, and returning void, that validates the component's local value.
valueChangeListener	false	false	`java.lang.String`	A method binding EL expression, accepting a ValueChangeEvent parameter and returning void. The specified method is invoked if this component is modified. The phase that this handler is fired in can be controlled via the immediate attribute.
immediate	false	false	`java.lang.String`	A boolean value that identifies the phase during which value change events should fire. During normal event processing, value change events are fired during the "process validations" phase of request processing. If this attribute is set to "true", these methods are fired instead at the end of the "apply request values" phase.
required	false	false	`java.lang.String`	A boolean value that indicates whether an input value is required. If this value is true, and no input value is provided, the error message javax.faces.component.UIInput.REQUIRED is posted.
converter	false	false	`java.lang.String`	The value can either be a static value (ID) or an EL expression. When a static id is specified, an instance of the converter type registered with that id is used. When this is an EL expression, the result of evaluating the expression must be an object that implements the Converter interface.
value	false	false	`java.lang.String`	The initial value of this component. This value is generally set as a value-binding in the form #{myBean.myProperty}, where myProperty can be any data-type of Java (also user-defined data-types), if a converter for this data-type exists. Special cases: 1) f:selectItems - value needs to bind to a list (or an array) of javax.faces.model.SelectItem-instances 2) components implementing UISelectMany (e.g. h:selectManyCheckbox) - value needs to bind to a list (or an array) of values, where the values need to be of the same data-type as the choices of the associated f:selectItems-component 3) components implementing UIData (e.g. h:dataTable) - value needs to bind to a list (or an array) of values, which will be iterated over when the data-table is processed
id	false	false	`java.lang.String`	An identifier for this particular component instance within a component view. The id must be unique within the scope of the tag's enclosing NamingContainer (eg h:form or f:subview). The id is not necessarily unique across all components in the current view This value must be a static value, ie not change over the lifetime of a component. It cannot be defined via an EL expression; only a string is permitted.
rendered	false	false	`java.lang.String`	A boolean value that indicates whether this component should be rendered. Default value: true.
binding	false	false	`java.lang.String`	Identifies a backing bean property (of type UIComponent or appropriate subclass) to bind to this component instance. This value must be an EL expression.

Variables
No Variables Defined.

Overview

Library

Tag

Help

FRAMES NO FRAMES

Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.

Tomahawk tag library. Tag inputCalendar

Tomahawk tag library.
Tag inputCalendar