2004-10-13 13:51:52 +04:00
|
|
|
/* -*- 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
|
|
|
|
* IBM Corporation.
|
|
|
|
* Portions created by the Initial Developer are Copyright (C) 2004
|
|
|
|
* the Initial Developer. All Rights Reserved.
|
|
|
|
*
|
|
|
|
* Contributor(s):
|
|
|
|
* Brian Ryner <bryner@brianryner.com>
|
|
|
|
*
|
|
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
|
|
* either 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 ***** */
|
|
|
|
|
|
|
|
#ifndef nsXFormsModelElement_h_
|
|
|
|
#define nsXFormsModelElement_h_
|
|
|
|
|
2004-11-04 03:24:40 +03:00
|
|
|
#include "nsXFormsStubElement.h"
|
2004-10-26 04:34:03 +04:00
|
|
|
#include "nsIModelElementPrivate.h"
|
2004-12-15 22:46:10 +03:00
|
|
|
#include "nsIDOMEventListener.h"
|
2004-10-13 13:51:52 +04:00
|
|
|
#include "nsISchema.h"
|
|
|
|
#include "nsCOMArray.h"
|
|
|
|
#include "nsVoidArray.h"
|
|
|
|
#include "nsCOMPtr.h"
|
|
|
|
#include "nsIDOMDocument.h"
|
2004-11-13 03:22:30 +03:00
|
|
|
#include "nsXFormsMDGEngine.h"
|
2005-05-05 11:09:40 +04:00
|
|
|
#include "nsXFormsUtils.h"
|
2004-10-13 13:51:52 +04:00
|
|
|
|
|
|
|
#include "nsISchemaLoader.h"
|
|
|
|
#include "nsISchema.h"
|
2005-06-20 23:08:46 +04:00
|
|
|
#include "nsIXFormsContextControl.h"
|
2004-10-13 13:51:52 +04:00
|
|
|
|
|
|
|
class nsIDOMElement;
|
|
|
|
class nsIDOMNode;
|
2005-01-28 02:02:27 +03:00
|
|
|
class nsIXFormsXPathEvaluator;
|
2004-11-13 03:22:30 +03:00
|
|
|
class nsIDOMXPathResult;
|
2004-10-13 13:51:52 +04:00
|
|
|
class nsXFormsControl;
|
|
|
|
|
2004-11-05 00:12:22 +03:00
|
|
|
/**
|
|
|
|
* Implementation of the XForms \<model\> element.
|
|
|
|
*
|
|
|
|
* This includes all of the code for loading the model's external resources and
|
|
|
|
* initializing the model and its controls.
|
|
|
|
*
|
|
|
|
* @see http://www.w3.org/TR/xforms/slice3.html#structure-model
|
|
|
|
*/
|
2004-11-04 03:24:40 +03:00
|
|
|
class nsXFormsModelElement : public nsXFormsStubElement,
|
2004-10-26 04:34:03 +04:00
|
|
|
public nsIModelElementPrivate,
|
2004-10-13 13:51:52 +04:00
|
|
|
public nsISchemaLoadListener,
|
2005-06-20 23:08:46 +04:00
|
|
|
public nsIDOMEventListener,
|
|
|
|
public nsIXFormsContextControl
|
2004-10-13 13:51:52 +04:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
nsXFormsModelElement() NS_HIDDEN;
|
|
|
|
|
2004-11-04 03:24:40 +03:00
|
|
|
NS_DECL_ISUPPORTS_INHERITED
|
2004-10-13 13:51:52 +04:00
|
|
|
NS_DECL_NSIXFORMSMODELELEMENT
|
2004-10-26 04:34:03 +04:00
|
|
|
NS_DECL_NSIMODELELEMENTPRIVATE
|
2004-10-13 13:51:52 +04:00
|
|
|
NS_DECL_NSISCHEMALOADLISTENER
|
|
|
|
NS_DECL_NSIWEBSERVICEERRORHANDLER
|
|
|
|
NS_DECL_NSIDOMEVENTLISTENER
|
2005-06-20 23:08:46 +04:00
|
|
|
NS_DECL_NSIXFORMSCONTEXTCONTROL
|
2004-10-13 13:51:52 +04:00
|
|
|
|
2004-11-04 03:24:40 +03:00
|
|
|
// nsIXTFGenericElement overrides
|
|
|
|
NS_IMETHOD OnDestroyed();
|
|
|
|
NS_IMETHOD GetScriptingInterfaces(PRUint32 *aCount, nsIID ***aArray);
|
|
|
|
NS_IMETHOD WillChangeDocument(nsIDOMDocument *aNewDocument);
|
|
|
|
NS_IMETHOD DocumentChanged(nsIDOMDocument *aNewDocument);
|
|
|
|
NS_IMETHOD DoneAddingChildren();
|
|
|
|
NS_IMETHOD HandleDefault(nsIDOMEvent *aEvent, PRBool *aHandled);
|
|
|
|
NS_IMETHOD OnCreated(nsIXTFGenericElementWrapper *aWrapper);
|
|
|
|
|
2004-10-13 13:51:52 +04:00
|
|
|
// Called after nsXFormsAtoms is registered
|
|
|
|
static NS_HIDDEN_(void) Startup();
|
|
|
|
|
2005-05-17 15:30:43 +04:00
|
|
|
/**
|
|
|
|
* The models are not ready for binding, so defer the binding of the control
|
|
|
|
* by storing it as a property on the document. The models will run through
|
|
|
|
* this list when they are ready for binding.
|
|
|
|
*
|
|
|
|
* @param aDoc Document that contains aElement
|
|
|
|
* @param aControl XForms control waiting to be bound
|
|
|
|
*/
|
|
|
|
static NS_HIDDEN_(nsresult) DeferElementBind(nsIDOMDocument *aDoc,
|
|
|
|
nsIXFormsControl *aControl);
|
|
|
|
|
2004-10-13 13:51:52 +04:00
|
|
|
private:
|
2004-10-26 04:34:03 +04:00
|
|
|
|
|
|
|
NS_HIDDEN_(already_AddRefed<nsIDOMDocument>)
|
|
|
|
FindInstanceDocument(const nsAString &aID);
|
2005-02-01 02:56:27 +03:00
|
|
|
NS_HIDDEN_(void) Reset();
|
|
|
|
NS_HIDDEN_(void) Ready();
|
|
|
|
NS_HIDDEN_(void) BackupOrRestoreInstanceData(PRBool restore);
|
2004-10-26 04:34:03 +04:00
|
|
|
|
2005-02-01 19:02:54 +03:00
|
|
|
/** Initializes the MIPs on all form controls */
|
2005-05-05 11:09:40 +04:00
|
|
|
NS_HIDDEN_(nsresult) InitializeControls();
|
2005-02-01 19:02:54 +03:00
|
|
|
|
2005-02-01 02:41:00 +03:00
|
|
|
NS_HIDDEN_(nsresult) ProcessBindElements();
|
2004-10-13 13:51:52 +04:00
|
|
|
NS_HIDDEN_(nsresult) FinishConstruction();
|
2005-02-01 19:02:54 +03:00
|
|
|
NS_HIDDEN_(nsresult) ConstructDone();
|
2004-12-15 22:46:10 +03:00
|
|
|
NS_HIDDEN_(void) MaybeNotifyCompletion();
|
2004-10-26 04:34:03 +04:00
|
|
|
|
2005-05-05 11:09:40 +04:00
|
|
|
NS_HIDDEN_(nsresult) ProcessBind(nsIXFormsXPathEvaluator *aEvaluator,
|
2005-01-28 02:02:27 +03:00
|
|
|
nsIDOMNode *aContextNode,
|
2005-05-05 11:09:40 +04:00
|
|
|
PRInt32 aContextPosition,
|
|
|
|
PRInt32 aContextSize,
|
2005-01-28 02:02:27 +03:00
|
|
|
nsIDOMElement *aBindElement);
|
2004-10-13 13:51:52 +04:00
|
|
|
|
|
|
|
NS_HIDDEN_(void) RemoveModelFromDocument();
|
|
|
|
|
2005-01-19 19:05:31 +03:00
|
|
|
/**
|
2005-05-05 11:09:40 +04:00
|
|
|
* Set the states on the control |aControl| bound to the instance data node
|
|
|
|
* |aNode|. It dispatches the necessary events and sets the pseudo class
|
|
|
|
* states. |aAllStates| determines whether all states should be set, or only
|
|
|
|
* changed.
|
2005-02-01 19:02:54 +03:00
|
|
|
*
|
|
|
|
* @param aControl The event target
|
|
|
|
* @param aNode The instance node
|
2005-05-05 11:09:40 +04:00
|
|
|
* @param aAllStates Set all states (PR_TRUE), or only changed
|
2005-01-19 19:05:31 +03:00
|
|
|
*/
|
2005-05-05 11:09:40 +04:00
|
|
|
NS_HIDDEN_(nsresult) SetStatesInternal(nsIXFormsControl *aControl,
|
|
|
|
nsIDOMNode *aNode,
|
|
|
|
PRBool aAllStates = PR_FALSE);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets the state of a specific state.
|
|
|
|
*
|
|
|
|
* @param aElement The element to dispatch events to and set states on
|
|
|
|
* @param aState The state value
|
|
|
|
* @param aOnEvent The on event for the state.
|
|
|
|
* @param aAttributePos The position of the "on" attribute in kStateAttributes
|
|
|
|
*
|
|
|
|
* @note aAttributePos is only needed until bug 271720 is landed.
|
|
|
|
*/
|
|
|
|
NS_HIDDEN_(void) SetSingleState(nsIDOMElement *aElement,
|
|
|
|
PRBool aState,
|
|
|
|
nsXFormsEvent aOnEvent,
|
|
|
|
PRUint32 aAttributePos);
|
2005-01-19 19:05:31 +03:00
|
|
|
|
2005-05-17 15:30:43 +04:00
|
|
|
/**
|
|
|
|
* Call the Bind() and Refresh() on controls which was deferred because
|
|
|
|
* the model was not ready.
|
|
|
|
*
|
|
|
|
* @param aDoc Document that contains the XForms control
|
|
|
|
*/
|
|
|
|
static NS_HIDDEN_(void) ProcessDeferredBinds(nsIDOMDocument *aDoc);
|
|
|
|
|
2004-12-15 22:46:10 +03:00
|
|
|
// Returns true when all external documents have been loaded
|
2004-11-11 02:24:23 +03:00
|
|
|
PRBool IsComplete() const { return (mSchemaTotal == mSchemaCount
|
2004-10-13 13:51:52 +04:00
|
|
|
&& mPendingInstanceCount == 0); }
|
|
|
|
|
2004-11-11 02:24:23 +03:00
|
|
|
nsIDOMElement *mElement;
|
|
|
|
nsCOMPtr<nsISchemaLoader> mSchemas;
|
2004-12-15 22:46:10 +03:00
|
|
|
nsStringArray mPendingInlineSchemas;
|
|
|
|
nsVoidArray mFormControls;
|
2004-10-13 13:51:52 +04:00
|
|
|
|
|
|
|
PRInt32 mSchemaCount;
|
2004-11-11 02:24:23 +03:00
|
|
|
PRInt32 mSchemaTotal;
|
2004-10-13 13:51:52 +04:00
|
|
|
PRInt32 mPendingInstanceCount;
|
2004-12-15 22:46:10 +03:00
|
|
|
|
2005-01-19 19:05:31 +03:00
|
|
|
/** The MDG for this model */
|
2004-11-13 03:22:30 +03:00
|
|
|
nsXFormsMDGEngine mMDG;
|
2004-12-15 22:46:10 +03:00
|
|
|
|
2005-02-01 23:23:41 +03:00
|
|
|
/**
|
|
|
|
* List of changed nodes, ie. nodes that have not been informed about
|
|
|
|
* changes yet
|
|
|
|
*/
|
2005-02-24 17:35:27 +03:00
|
|
|
nsCOMArray<nsIDOMNode> mChangedNodes;
|
2005-01-19 19:05:31 +03:00
|
|
|
|
2005-02-01 23:23:41 +03:00
|
|
|
/* Controls that need to a Refresh() */
|
|
|
|
nsVoidArray mControlsNeedingRefresh;
|
|
|
|
|
2004-12-15 22:46:10 +03:00
|
|
|
// This flag indicates whether or not the document fired DOMContentLoaded
|
|
|
|
PRBool mDocumentLoaded;
|
2005-04-15 13:44:06 +04:00
|
|
|
|
|
|
|
// This flag indicates whether a xforms-rebuild has been called, but no
|
|
|
|
// xforms-revalidate yet
|
|
|
|
PRBool mNeedsRefresh;
|
2004-10-13 13:51:52 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
NS_HIDDEN_(nsresult) NS_NewXFormsModelElement(nsIXTFElement **aResult);
|
|
|
|
|
|
|
|
#endif
|