extensions/xforms/nsXFormsGroupElement.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla XForms support.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Novell, Inc.
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Allan Beaufour <abeaufour@novell.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38 #include "nsAutoPtr.h"
  39 #include "nsCOMPtr.h"
  40 #include "nsStringAPI.h"
  41
  42 #include "nsIDOM3Node.h"
  43 #include "nsIDOMElement.h"
  44 #include "nsIDOMDocument.h"
  45 #include "nsIDOMNodeList.h"
  46 #include "nsIDOMEventTarget.h"
  47 #include "nsIDOMXPathResult.h"
  48 #include "nsIDOMHTMLDivElement.h"
  49
  50 #include "nsXFormsControlStub.h"
  51 #include "nsIModelElementPrivate.h"
  52 #include "nsXFormsUtils.h"
  53 #include "nsXFormsDelegateStub.h"
  54
  55 #ifdef DEBUG
  56 // #define DEBUG_XF_GROUP
  57 #endif
  58
  59 /**
  60  * Implementation of the XForms \<group\> control.
  61  *
  62  * @see http://www.w3.org/TR/xforms/slice9.html#id2631290
  63  *
  64  * @todo XXX: If a \<label\> is the first element child for \<group\> it is the
  65  * label for the entire group
  66  *
  67  * @todo XXX: With some small adjustments we could let nsXFormsContextContainer
  68  * implement group, and get rid of this class (XXX).
  69  */
  70
  71 class nsXFormsGroupElement : public nsXFormsDelegateStub
  72 {
  73 protected:
  74   /** Tries to focus a child form control.*/
  75   PRBool TryFocusChildControl(nsIDOMNode *aParent);
  76
  77 public:
  78   // nsIXFormsControl
  79   NS_IMETHOD TryFocus(PRBool *aOK);
  80
  81 #ifdef DEBUG_smaug
  82   virtual const char* Name() { return "group"; }
  83 #endif
  84
  85 };
  86
  87 PRBool
  88 nsXFormsGroupElement::TryFocusChildControl(nsIDOMNode* aParent)
  89 {
  90   if (!aParent)
  91     return PR_FALSE;
  92
  93   nsCOMPtr<nsIDOMNodeList> children;
  94   nsresult rv = aParent->GetChildNodes(getter_AddRefs(children));
  95   if (NS_FAILED(rv))
  96     return PR_FALSE;
  97
  98   PRUint32 childCount = 0;
  99   children->GetLength(&childCount);
 100   nsCOMPtr<nsIDOMNode> child;
 101
 102   for (PRUint32 i = 0; i < childCount; ++i) {
 103     children->Item(i, getter_AddRefs(child));
 104     nsCOMPtr<nsIXFormsControl> control(do_QueryInterface(child));
 105     PRBool focus = PR_FALSE;
 106     if (control) {
 107       control->TryFocus(&focus);
 108       if (focus)
 109         return PR_TRUE;
 110     }
 111     focus = TryFocusChildControl(child);
 112     if (focus)
 113       return PR_TRUE;
 114   }
 115
 116   return PR_FALSE;
 117 }
 118
 119 NS_IMETHODIMP
 120 nsXFormsGroupElement::TryFocus(PRBool* aOK)
 121 {
 122   *aOK = PR_FALSE;
 123   if (GetRelevantState()) {
 124     *aOK = TryFocusChildControl(mElement);
 125   }
 126   return NS_OK;
 127 }
 128
 129 // Factory
 130 NS_HIDDEN_(nsresult)
 131 NS_NewXFormsGroupElement(nsIXTFElement **aResult)
 132 {
 133   *aResult = new nsXFormsGroupElement();
 134   if (!*aResult)
 135   return NS_ERROR_OUT_OF_MEMORY;
 136
 137   NS_ADDREF(*aResult);
 138   return NS_OK;
 139 }