path: root/webapps/qooxdoo-0.6.5-sdk/frontend/framework/source/class/qx/ui/component/DateChooserButton.js

/* ************************************************************************

   qooxdoo - the new era of web development

   http://qooxdoo.org

   Copyright:
     2006 Visionet GmbH, Germany, http://www.visionet.de

   License:
     LGPL: http://www.gnu.org/licenses/lgpl.html
     EPL: http://www.eclipse.org/org/documents/epl-v10.php
     See the LICENSE file in the project's top-level directory for details.

   Authors:
     * Dietrich Streifert (level420)

************************************************************************ */

/* ************************************************************************

#require(qx.ui.component.DateChooser)
#require(qx.util.format.DateFormat)

************************************************************************ */

/**
 * A date chooser button widget which can be associated to a widget where the date value is synchronized
 * whith the selected date.
 *
 * @param vTargetWidget {qx.ui.core.Widget} the widget which is the target for the date value selection. The target widget must have a setValue and getValue method.
 * @param vChooserTitle {String} the title of the chooser window. The default value is held in property chooserTitle.
 * @param vButtonLabel {String} the label of the button. The default is null.
 * @param vIcon {String} the icon of the button. The default is 'icon/16/apps/accessories-date.png'.
 * @param vIconWidth {String} derived from qx.ui.form.Button.
 * @param vIconHeight {String} derived from qx.ui.form.Button.
 * @param vFlash {String} derived from qx.ui.form.Button.
 */
qx.OO.defineClass("qx.ui.component.DateChooserButton", qx.ui.form.Button, function(vTargetWidget, vChooserTitle, vButtonLabel, vIcon, vIconWidth, vIconHeight, vFlash)
{
  if (!vIcon) {
    vIcon = 'icon/16/apps/accessories-date.png';
  }

  qx.ui.form.Button.call(this, vButtonLabel, vIcon, vIconWidth, vIconHeight, vFlash);
  this.set({ height : 20 });

  // create the subwidgets
  //
  this._createChooser();
  this._createChooserWindow();

  // create dateFormat instance
  //
  this._dateFormat = new qx.util.format.DateFormat(qx.locale.Date.getDateFormat("short"));
  qx.locale.Manager.getInstance().addEventListener("changeLocale", this._changeLocale, this);

  if (vTargetWidget) {
    this.setTargetWidget(vTargetWidget);
  }

  if (vChooserTitle) {
    this.setChooserTitle(vChooserTitle);
  }

  this.addEventListener("execute", this._executeHandler, this);
});




/*
---------------------------------------------------------------------------
  PROPERTIES
---------------------------------------------------------------------------
*/

/** The target widget the selected Date should be synchronized with. */
qx.OO.addProperty(
{
  name         : "targetWidget",
  type         : "object",
  instance     : "qx.ui.core.Widget",
  defaultValue : null
});

/** The title of the date chooser window. */
qx.OO.addProperty(
{
  name         : "chooserTitle",
  defaultValue : qx.locale.Manager.tr("Choose a date")
});




/*
---------------------------------------------------------------------------
  MODIFIERS
---------------------------------------------------------------------------
*/

/**
 * Modifier for property targetWidget.
 *
 * @type member
 * @name _modifyTargetWidget
 * @access protected
 * @param propValue {var} Current value
 * @param propOldValue {var} Previous value
 * @param propData {var} Property configuration map
 * @return {Boolean} true if modification succeeded
 * @throws exception if propValue is not instance of qx.ui.core.Widget or does not have setter and getter for property value
 */
qx.Proto._modifyTargetWidget = function(propValue, propOldValue, propData)
{
  if (propValue instanceof qx.ui.core.Widget && qx.util.Validation.isValidFunction(propValue.setValue) && qx.util.Validation.isValidFunction(propValue.getValue)) {
    return true;
  } else {
    throw new error("TargetWidget must be an instance of qx.ui.core.Widget and has setValue and getValue methods");
  }
};

/**
 * Modifier for property chooserTitle.
 *
 * @type member
 * @name _modifyChooserTitle
 * @access protected
 * @param propValue {var} Current value
 * @param propOldValue {var} Previous value
 * @param propData {var} Property configuration map
 * @return {Boolean} true if modification succeeded
 */
qx.Proto._modifyChooserTitle = function(propValue, propOldValue, propData)
{
  this._chooserWindow.setCaption(propValue);
  return true;
};




/*
---------------------------------------------------------------------------
  SUB WIDGET CREATION
---------------------------------------------------------------------------
*/

/**
 * Create the popup window with for the date chooser and add the date chooser to it.
 *
 * @type member
 * @name _createChooserWindow
 * @access protected
 * @return {void}
 */
qx.Proto._createChooserWindow = function()
{
  var win = this._chooserWindow = new qx.ui.window.Window(this.getChooserTitle());

  win.addEventListener("keydown", this._chooserWindowKeydownHandler, this);
  win.addEventListener("appear", this._chooserWindowAppearHandler, this);

  win.set(
  {
    top           : 50,
    left          : 50,
    modal         : true,
    minWidth      : null,
    minHeight     : null,
    resizeable    : false,
    allowMinimize : false,
    allowMaximize : false,
    showMaximize  : false,
    showMinimize  : false
  });

  win.auto();
  win.add(this._chooser);
  win.addToDocument();
};

/**
 * Create the date chooser
 *
 * @type member
 * @name _createChooser
 * @access protected
 * @return {void}
 */
qx.Proto._createChooser = function()
{
  var cp = this._chooser = new qx.ui.component.DateChooser;
  cp.auto();
  cp.setBorder(null);

  cp.addEventListener("select", this._chooserSelectHandler, this);
};




/*
---------------------------------------------------------------------------
  EVENT HANDLER
---------------------------------------------------------------------------
*/

/**
 * Event hanlder for the execute event of the date chooser button.
 *
 * @type member
 * @name _executeHandler
 * @access protected
 * @param e {Event} the received event
 * @return {void}
 * @throws exception if the target widget is not instance of qx.ui.core.Widget or does not have setter and getter for property value
 */
qx.Proto._executeHandler = function(e)
{
  if (qx.util.Validation.isInvalidObject(this.getTargetWidget())) {
    throw new error("TargetWidget must be set which must be an instance of qx.ui.core.Widget and has setValue and getValue method.");
  }

  var date = null;

  try {
    date = this._dateFormat.parse(this.getTargetWidget().getValue());
  } catch(ex) {}

  // value from taget widget could not be parsed.
  this._chooser.setDate(date);
  this._chooserWindow.open();
};


/**
 * Handle locale changes. Update the date format of the target widget.
 *
 * @param e {Event} the received event
 */
qx.Proto._changeLocale = function(e) {
  if (qx.util.Validation.isInvalidObject(this.getTargetWidget())) {
    throw new error("TargetWidget must be set which must be an instance of qx.ui.core.Widget and has setValue and getValue method.");
  }

  var date = null;

  try {
    date = this._dateFormat.parse(this.getTargetWidget().getValue());
  } catch(ex) {}


  this._dateFormat = new qx.util.format.DateFormat(qx.locale.Date.getDateFormat("short"));

  if (!date) {
    return;
  }

  this._chooser.setDate(date);
  this.getTargetWidget().setValue(this._dateFormat.format(date));
};


/**
 * Event handler for keydown events of the chooser window. Closes the window on hitting the 'Escape' key.
 *
 * @type member
 * @name _chooserWindowKeydownHandler
 * @access protected
 * @param e {Event} the received key event
 * @return {void}
 */
qx.Proto._chooserWindowKeydownHandler = function(e)
{
  switch(e.getKeyIdentifier())
  {
    case "Escape":
      this._chooserWindow.close();
      this.getTargetWidget().focus();
      break;
  }
};

/**
 * Event handler for chooser window appear event. Positions the window above the target widget.
 *
 * @type member
 * @name _chooserWindowAppearHandler
 * @access protected
 * @param e {Event} the received appear event
 * @return {void}
 */
qx.Proto._chooserWindowAppearHandler = function(e)
{
  this._chooserWindow.positionRelativeTo(this.getTargetWidget());
  this._chooser.focus();
};

/**
 * Event handler for the date chooser select event. Formats the selected date as string and sets the target widgets value.
 *
 * @type member
 * @name _chooserSelectHandler
 * @access protected
 * @param e {Event} the select event
 * @return {void}
 */
qx.Proto._chooserSelectHandler = function(e)
{
  target = this.getTargetWidget();
  target.setValue(this._dateFormat.format(this._chooser.getDate()));
  this._chooserWindow.close();
  target.focus();
};




/*
---------------------------------------------------------------------------
  DISPOSER
---------------------------------------------------------------------------
*/

/**
 * Disposer. Removes all assigned event listeners and disposes the subwidgets.
 *
 * @type member
 * @name dispose
 * @access public
 * @return {void | call}
 */
qx.Proto.dispose = function()
{
  if (this.getDisposed()) {
    return;
  }

  this._dateFormat.dispose();
  this._dateFormat = null;

  this._chooser.removeEventListener("select", this._chooserSelectHandler);
  this._chooser.dispose();
  this._chooser = null;

  this._chooserWindow.removeEventListener("appear", this._chooserWindowAppearHandler);
  this._chooserWindow.removeEventListener("keydown", this._chooserWindowKeydownHandler);
  this._chooserWindow.dispose();
  this._chooserWindow = null;

  this.removeEventListener("execute", this._executeHandler);

  return qx.ui.form.Button.prototype.dispose.call(this);
};