The default Calendar/CalendarGroup controls do not provide positioning or dragdrop support natively, as the Container family's Overlay control and its subclasses do.
This example demonstrates how the Calendar control can be wrapped in a Container (a Dialog control in this case) which allows you to leverage Container family features to position the Calendar relative to a context element. It also show how you can setup click listeners on the document, to hide the dialog when the user clicks somewhere outside of the dialog.
In this example, we'll see how we can leverage functionality present in the Container family's Dialog widget, to provide a more advanced popup Calendar, than the basic popup features which Calendar supports inherently.
contextconfiguration property to position the Calendar relative to a calendar icon button.
buttonsproperty to provide a "Reset" button to set the calendar page to the selected date, and a more prominent "Close" button to hide the popup Calendar.
falsefor this example, however if the application required it, we could set
trueto get a draggable popup Calendar
The code we use to construct the Dialog which will hold the Calendar is shown below:
We don't set a width on the Dialog, so that it will shrink-wrap the Calendar, which does not have a specific width defined (the width of the calendar is controlled by the width of its contents).
The code to construct the Calendar is pretty straight forward, and is shown below:
For this example, both the Dialog and the Calendar are constructed lazily. That is, we don't construct them until the "calendar" button is clicked on for the first time.
When creating a Calendar which is to be placed inside a Container control there are a few areas which require special attention.
Whenever the contents of the Calendar are changed we fire Dialog's
changeContent event so any of Dialog's rendered elements which need to be kept in sync are redrawn (such as the size of the shadow underlay for IE6/Safari2). We could optimize this, by checking for an actual change in dimensions before firing the
changeContent event, using Calendar's
beforeRenderEvent but the simpler approach is taken for the purposes of the example.
The Calendar has
hide_blank_weeks set to
true to illustrate the fact that the shadow is resized when the height of the Calendar changes.
Since we're using the
yui-overlay-hidden class to hide all tables in IE, while the container is hidden (see the discussion on
border-collapse:collapse, below), we also fire the
changeContent event for IE when showing the Dialog, to let it know that
the tables have been re-shown, which may impact the height of the Dialog:
NOTE: Normally if you were to change the contents of the Dialog's header, body or footer elements (e.g. using
changeContent would be fired automatically, but in this case, we're changing the contents of the Calendar, and not the body element directly so we need to inform the Dialog that something inside the body changed.
Since dialog has a form element, we'll use it to clear Calendar's float:left and allow the Dialog body element to wrap the Calendar.
For IE6/7, we want to avoid activating
zoom:1;) to clear the float for IE. If
hasLayout was activated, the Dialog would not shrink-wrap the Calendar correctly in IE6/7 and we'd need to define a specific width for the Dialog, hence we use an element to clear the left float.
iframe property is set to
false since the Dialog already provides iframe shim support and we want to avoid duplicating shims for performance reasons.
IE6 and IE7 have a known issue related to collapsed table borders remaining visible even though the table's containing element has its
visibility set to
hidden (See Container known issues).
Since the Sam skin Calendar uses
border-collapse:collapse and the Dialog is hidden using
visibility:hidden, we need to use the workaround mentioned in the known issues section above, to make sure Calendar's table borders get hidden when the Dialog is hidden.
We use the
yui-overlay-hidden class to define a rule which hides all tables, using
display:none, when the container is hidden:
The example also shows how you can hide the dialog, when the user clicks on an area of the document outside of the dialog. A
click listener is set up on the document, so it receives notification whenever the user clicks on the document. Inside the listener, we try to determine if the element the user clicked on (the event target) is inside the dialog's containing element (
dialog.element) or the button which is used to display the dialog. It if is not, the dialog is hidden:
All YUI 2.x users should review the YUI 2.8.2 security bulletin, which discusses a vulnerability present in YUI 2.4.0-2.8.1.