gecko-dev/extensions/xforms/nsXFormsControlStub.cpp

416 строки
12 KiB
C++

/* -*- 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
* Novell, Inc.
* Portions created by the Initial Developer are Copyright (C) 2004
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Allan Beaufour <abeaufour@novell.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 ***** */
#include "nsIModelElementPrivate.h"
#include "nsXFormsAtoms.h"
#include "nsXFormsControlStub.h"
#include "nsXFormsMDGEngine.h"
#include "nsIDOMEvent.h"
#include "nsIDOMKeyEvent.h"
#include "nsIDOMEventTarget.h"
#include "nsIDOMXPathResult.h"
#include "nsIXTFXMLVisualWrapper.h"
/** This class is used to generate xforms-hint and xforms-help events.*/
class nsXFormsHintHelpListener : public nsIDOMEventListener {
public:
NS_DECL_ISUPPORTS
NS_DECL_NSIDOMEVENTLISTENER
};
NS_IMPL_ISUPPORTS1(nsXFormsHintHelpListener, nsIDOMEventListener)
NS_IMETHODIMP
nsXFormsHintHelpListener::HandleEvent(nsIDOMEvent* aEvent)
{
if (!aEvent)
return NS_ERROR_UNEXPECTED;
nsCOMPtr<nsIDOMEventTarget> target;
aEvent->GetCurrentTarget(getter_AddRefs(target));
nsCOMPtr<nsIDOMNode> targetNode(do_QueryInterface(target));
nsCOMPtr<nsIDOMKeyEvent> keyEvent(do_QueryInterface(aEvent));
if (keyEvent) {
PRUint32 code = 0;
keyEvent->GetKeyCode(&code);
if (code == nsIDOMKeyEvent::DOM_VK_F1)
nsXFormsUtils::DispatchEvent(targetNode, eEvent_Help);
} else {
nsXFormsUtils::DispatchEvent(targetNode, eEvent_Hint);
}
return NS_OK;
}
NS_IMPL_ISUPPORTS_INHERITED2(nsXFormsControlStub,
nsXFormsXMLVisualStub,
nsIXFormsContextControl,
nsIXFormsControl)
NS_IMETHODIMP
nsXFormsControlStub::GetBoundNode(nsIDOMNode **aBoundNode)
{
NS_IF_ADDREF(*aBoundNode = mBoundNode);
return NS_OK;
}
NS_IMETHODIMP
nsXFormsControlStub::GetDependencies(nsIArray **aDependencies)
{
NS_IF_ADDREF(*aDependencies = mDependencies);
return NS_OK;
}
NS_IMETHODIMP
nsXFormsControlStub::GetElement(nsIDOMElement **aElement)
{
NS_IF_ADDREF(*aElement = mElement);
return NS_OK;
}
NS_IMETHODIMP
nsXFormsControlStub::ResetBoundNode()
{
mBoundNode = nsnull;
nsCOMPtr<nsIModelElementPrivate> modelNode;
nsCOMPtr<nsIDOMXPathResult> result;
nsresult rv =
ProcessNodeBinding(NS_LITERAL_STRING("ref"),
nsIDOMXPathResult::FIRST_ORDERED_NODE_TYPE,
getter_AddRefs(result),
getter_AddRefs(modelNode));
NS_ENSURE_SUCCESS(rv, rv);
if (!result) {
return NS_OK;
}
// Get context node, if any
result->GetSingleNodeValue(getter_AddRefs(mBoundNode));
return NS_OK;
}
/**
* @note Refresh() is always called after a Bind(), so if a control decides to
* do all the work in Refresh() this function implements a NOP Bind().
*/
NS_IMETHODIMP
nsXFormsControlStub::Bind()
{
return ResetBoundNode();
}
NS_IMETHODIMP
nsXFormsControlStub::TryFocus(PRBool* aOK)
{
*aOK = PR_FALSE;
return NS_OK;
}
nsresult
nsXFormsControlStub::ProcessNodeBinding(const nsString &aBindingAttr,
PRUint16 aResultType,
nsIDOMXPathResult **aResult,
nsIModelElementPrivate **aModel)
{
nsresult rv;
if (!mDependencies) {
rv = NS_NewArray(getter_AddRefs(mDependencies));
} else {
rv = mDependencies->Clear();
}
NS_ENSURE_SUCCESS(rv, rv);
rv = nsXFormsUtils::EvaluateNodeBinding(mElement,
kElementFlags,
aBindingAttr,
EmptyString(),
aResultType,
getter_AddRefs(mModel),
aResult,
mDependencies);
if (mModel) {
mModel->AddFormControl(this);
if (aModel) {
NS_ADDREF(*aModel = mModel);
}
}
return rv;
}
void
nsXFormsControlStub::ResetHelpAndHint(PRBool aInitialize)
{
nsCOMPtr<nsIDOMEventTarget> targ(do_QueryInterface(mElement));
if (!targ)
return;
NS_NAMED_LITERAL_STRING(mouseover, "mouseover");
NS_NAMED_LITERAL_STRING(focus, "focus");
NS_NAMED_LITERAL_STRING(keypress, "keypress");
if (mEventListener) {
targ->RemoveEventListener(mouseover, mEventListener, PR_TRUE);
targ->RemoveEventListener(focus, mEventListener, PR_TRUE);
targ->RemoveEventListener(keypress, mEventListener, PR_TRUE);
mEventListener = nsnull;
}
if (aInitialize) {
mEventListener = new nsXFormsHintHelpListener();
if (!mEventListener)
return;
targ->AddEventListener(mouseover, mEventListener, PR_TRUE);
targ->AddEventListener(focus, mEventListener, PR_TRUE);
targ->AddEventListener(keypress, mEventListener, PR_TRUE);
}
}
PRBool
nsXFormsControlStub::GetReadOnlyState()
{
PRBool res = PR_FALSE;
if (mElement) {
mElement->HasAttribute(NS_LITERAL_STRING("read-only"), &res);
}
return res;
}
PRBool
nsXFormsControlStub::GetRelevantState()
{
PRBool res = PR_FALSE;
if (mElement) {
mElement->HasAttribute(NS_LITERAL_STRING("enabled"), &res);
}
return res;
}
void
nsXFormsControlStub::ToggleProperty(const nsAString &aOn,
const nsAString &aOff)
{
if (mElement) {
mElement->SetAttribute(aOn, NS_LITERAL_STRING("1"));
mElement->RemoveAttribute(aOff);
}
}
NS_IMETHODIMP
nsXFormsControlStub::HandleDefault(nsIDOMEvent *aEvent,
PRBool *aHandled)
{
NS_ENSURE_ARG(aHandled);
if (aEvent) {
// Check that we are the target of the event
nsCOMPtr<nsIDOMEventTarget> target;
aEvent->GetTarget(getter_AddRefs(target));
nsCOMPtr<nsIDOMElement> targetE(do_QueryInterface(target));
if (targetE && targetE != mElement) {
*aHandled = PR_FALSE;
return NS_OK;
}
// Handle event
nsAutoString type;
aEvent->GetType(type);
*aHandled = PR_TRUE;
/// @todo Change to be less cut-n-paste-stylish. Everything can be extraced
/// from the sXFormsEventsEntries, only problem is the dash in
/// read-only/read-write... (XXX)
if (type.EqualsASCII(sXFormsEventsEntries[eEvent_Valid].name)) {
ToggleProperty(NS_LITERAL_STRING("valid"),
NS_LITERAL_STRING("invalid"));
} else if (type.EqualsASCII(sXFormsEventsEntries[eEvent_Invalid].name)) {
ToggleProperty(NS_LITERAL_STRING("invalid"),
NS_LITERAL_STRING("valid"));
} else if (type.EqualsASCII(sXFormsEventsEntries[eEvent_Enabled].name)) {
ToggleProperty(NS_LITERAL_STRING("enabled"),
NS_LITERAL_STRING("disabled"));
} else if (type.EqualsASCII(sXFormsEventsEntries[eEvent_Disabled].name)) {
ToggleProperty(NS_LITERAL_STRING("disabled"),
NS_LITERAL_STRING("enabled"));
} else if (type.EqualsASCII(sXFormsEventsEntries[eEvent_Required].name)) {
ToggleProperty(NS_LITERAL_STRING("required"),
NS_LITERAL_STRING("optional"));
} else if (type.EqualsASCII(sXFormsEventsEntries[eEvent_Optional].name)) {
ToggleProperty(NS_LITERAL_STRING("optional"),
NS_LITERAL_STRING("required"));
} else if (type.EqualsASCII(sXFormsEventsEntries[eEvent_Readonly].name)) {
ToggleProperty(NS_LITERAL_STRING("read-only"),
NS_LITERAL_STRING("read-write"));
} else if (type.EqualsASCII(sXFormsEventsEntries[eEvent_Readwrite].name)) {
ToggleProperty(NS_LITERAL_STRING("read-write"),
NS_LITERAL_STRING("read-only"));
} else if (type.EqualsASCII(sXFormsEventsEntries[eEvent_Focus].name)) {
PRBool tmp;
TryFocus(&tmp);
} else {
*aHandled = PR_FALSE;
}
}
return NS_OK;
}
NS_IMETHODIMP
nsXFormsControlStub::OnCreated(nsIXTFXMLVisualWrapper *aWrapper)
{
aWrapper->SetNotificationMask(kStandardNotificationMask);
aWrapper->GetElementNode(getter_AddRefs(mElement));
NS_ASSERTION(mElement, "Wrapper is not an nsIDOMElement, we'll crash soon");
ResetHelpAndHint(PR_TRUE);
return NS_OK;
}
NS_IMETHODIMP
nsXFormsControlStub::OnDestroyed()
{
ResetHelpAndHint(PR_FALSE);
if (mModel) {
mModel->RemoveFormControl(this);
mModel = nsnull;
}
mElement = nsnull;
return NS_OK;
}
NS_IMETHODIMP
nsXFormsControlStub::DocumentChanged(nsIDOMDocument *aNewDocument)
{
// We need to re-evaluate our instance data binding when our document
// changes, since our context can change
if (aNewDocument) {
Bind();
Refresh();
}
return NS_OK;
}
NS_IMETHODIMP
nsXFormsControlStub::ParentChanged(nsIDOMElement *aNewParent)
{
// We need to re-evaluate our instance data binding when our parent changes,
// since xmlns declarations or our context could have changed.
if (aNewParent) {
Bind();
Refresh();
}
return NS_OK;
}
NS_IMETHODIMP
nsXFormsControlStub::WillSetAttribute(nsIAtom *aName, const nsAString &aValue)
{
if (aName == nsXFormsAtoms::model ||
aName == nsXFormsAtoms::bind ||
aName == nsXFormsAtoms::ref) {
if (mModel)
mModel->RemoveFormControl(this);
}
return NS_OK;
}
NS_IMETHODIMP
nsXFormsControlStub::AttributeSet(nsIAtom *aName, const nsAString &aValue)
{
if (aName == nsXFormsAtoms::model ||
aName == nsXFormsAtoms::bind ||
aName == nsXFormsAtoms::ref) {
Bind();
Refresh();
}
return NS_OK;
}
// nsIXFormsContextControl
NS_IMETHODIMP
nsXFormsControlStub::SetContextNode(nsIDOMNode *aContextNode)
{
return NS_ERROR_NOT_IMPLEMENTED;
}
NS_IMETHODIMP
nsXFormsControlStub::GetContext(nsAString &aModelID,
nsIDOMNode **aContextNode,
PRInt32 *aContextPosition,
PRInt32 *aContextSize)
{
NS_ENSURE_ARG(aContextSize);
NS_ENSURE_ARG(aContextPosition);
*aContextPosition = 1;
*aContextSize = 1;
if (mBoundNode && aContextNode) {
CallQueryInterface(mBoundNode, aContextNode); // addrefs
NS_ASSERTION(*aContextNode, "could not QI context node from bound node?");
}
///
/// @todo expensive to run this
nsCOMPtr<nsIDOMElement> model = do_QueryInterface(mModel);
if (model) {
model->GetAttribute(NS_LITERAL_STRING("id"), aModelID);
}
return NS_OK;
}