Mozilla/mozilla/extensions/xforms/nsXFormsSetFocusElement.cpp

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Mozilla XForms support.
 *
 * The Initial Developer of the Original Code is
 * Olli Pettay.
 * Portions created by the Initial Developer are Copyright (C) 2004
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Olli Pettay <Olli.Pettay@helsinki.fi> (original author)
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsXFormsActionModuleBase.h"
#include "nsIDOMDocument.h"
#include "nsIDOMElement.h"
#include "nsStringAPI.h"
#include "nsCOMPtr.h"

class nsXFormsSetFocusElement : public nsXFormsActionModuleBase
{
public:
  nsXFormsSetFocusElement();
  virtual nsresult HandleSingleAction(nsIDOMEvent* aEvent,
                                      nsIXFormsActionElement *aParentAction);
};

nsXFormsSetFocusElement::nsXFormsSetFocusElement()
{
}

nsresult
nsXFormsSetFocusElement::HandleSingleAction(nsIDOMEvent* aEvent,
                                            nsIXFormsActionElement *aParentAction)
{
  // The control's ID can come from the value attribute of the child
  // 'control' element, the string-value of the child 'control'
  // element, or the control attribute of the setfocus
  // element. Precedence is in that order.

  nsAutoString control;
  nsCOMPtr<nsIDOMNode> controlNode, currentNode, tmpNode;
  PRUint16 nodeType;
  nsresult rv;

  mElement->GetFirstChild(getter_AddRefs(currentNode));
  while (currentNode) {
    currentNode->GetNodeType(&nodeType);
    if (nodeType == nsIDOMNode::ELEMENT_NODE) {
      // Check to see if it's a control element.
      nsAutoString localName, namespaceURI;
      currentNode->GetLocalName(localName);
      currentNode->GetNamespaceURI(namespaceURI);
      if (localName.EqualsLiteral("control") &&
          namespaceURI.EqualsLiteral(NS_NAMESPACE_XFORMS)) {
        controlNode = currentNode;
        break;
      }
    }
    currentNode->GetNextSibling(getter_AddRefs(tmpNode));
    currentNode.swap(tmpNode);
  }

  if (controlNode) {
    nsCOMPtr<nsIDOMElement> controlElement(do_QueryInterface(controlNode));
    if (controlElement) {
      nsAutoString value;
      controlElement->GetAttribute(NS_LITERAL_STRING("value"), value);
      if (!value.IsEmpty()) {
        // The control ID is given by the result of evaluating the
        // value attribute.
        nsCOMPtr<nsIModelElementPrivate> model;
        nsCOMPtr<nsIDOMXPathResult> xpRes;
        PRBool usesModelBind = PR_FALSE;
        rv = nsXFormsUtils::EvaluateNodeBinding(controlElement, 0,
                                                NS_LITERAL_STRING("value"),
                                                EmptyString(),
                                                nsIDOMXPathResult::STRING_TYPE,
                                                getter_AddRefs(model),
                                                getter_AddRefs(xpRes),
                                                &usesModelBind);
        NS_ENSURE_SUCCESS(rv, rv);
        if (xpRes) {
          rv = xpRes->GetStringValue(control);
          NS_ENSURE_SUCCESS(rv, rv);
        }
      }
      else {
        // Check the string content of the element.
        nsXFormsUtils::GetNodeValue(controlNode, control);
      }
    }
  }
  else {
    // The control ID must be specified on the setfocus element.
    mElement->GetAttribute(NS_LITERAL_STRING("control"), control);
  }

  // If there's no control, the action terminates with no effect.
  if (control.IsEmpty()) {
    return NS_OK;
  }

  nsCOMPtr<nsIDOMElement> el;
  nsXFormsUtils::GetElementById(control, PR_TRUE, mElement, getter_AddRefs(el));
  if (!el)
    return NS_OK;
  
  return nsXFormsUtils::DispatchEvent(el, eEvent_Focus);
}

NS_HIDDEN_(nsresult)
NS_NewXFormsSetFocusElement(nsIXTFElement **aResult)
{
  *aResult = new nsXFormsSetFocusElement();
  if (!*aResult)
    return NS_ERROR_OUT_OF_MEMORY;

  NS_ADDREF(*aResult);
  return NS_OK;
}