Mozilla/mozilla/layout/html/content/src/nsHTMLLabelElement.cpp
pollmann%netscape.com b70eecc2df Bug 49897: Only send focus and left click events from labels to target content r=jst@netscape.com
git-svn-id: svn://10.0.0.236/trunk@77796 18797224-902f-48f8-a5cc-f745e15eee43
2000-09-01 00:48:47 +00:00

498 lines
16 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* The contents of this file are subject to the Netscape 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/NPL/
*
* 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 Communicator client code.
*
* The Initial Developer of the Original Code is Netscape Communications
* Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All
* Rights Reserved.
*
* Contributor(s):
*/
#include "nsCOMPtr.h"
#include "nsIDOMHTMLLabelElement.h"
#include "nsIDOMHTMLFormElement.h"
#include "nsIScriptObjectOwner.h"
#include "nsIDOMEventReceiver.h"
#include "nsIHTMLContent.h"
#include "nsGenericHTMLElement.h"
#include "nsHTMLAtoms.h"
#include "nsHTMLIIDs.h"
#include "nsIStyleContext.h"
#include "nsIMutableStyleContext.h"
#include "nsStyleConsts.h"
#include "nsIPresContext.h"
#include "nsIFormControl.h"
#include "nsIForm.h"
#include "nsIDOMHTMLDocument.h"
#include "nsIDOMXULDocument.h"
#include "nsIDocument.h"
#include "nsISizeOfHandler.h"
#include "nsIFormControlFrame.h"
#include "nsIPresShell.h"
static NS_DEFINE_IID(kIDOMHTMLLabelElementIID, NS_IDOMHTMLLABELELEMENT_IID);
static NS_DEFINE_IID(kIDOMHTMLFormElementIID, NS_IDOMHTMLFORMELEMENT_IID);
static NS_DEFINE_IID(kIFormIID, NS_IFORM_IID);
static NS_DEFINE_IID(kIFormControlIID, NS_IFORMCONTROL_IID);
class nsHTMLLabelElement : public nsIDOMHTMLLabelElement,
public nsIJSScriptObject,
public nsIHTMLContent,
public nsIFormControl
{
public:
nsHTMLLabelElement(nsINodeInfo *aNodeInfo);
virtual ~nsHTMLLabelElement();
// nsISupports
NS_DECL_ISUPPORTS
// nsIDOMNode
NS_IMPL_IDOMNODE_USING_GENERIC(mInner)
// nsIDOMElement, because of the "htmlFor" attribute handling we can't
// use the NS_IMPL_IDOMELEMENT_USING_GENERIC macro here...
NS_IMETHOD GetTagName(nsAWritableString& aTagName) {
return mInner.GetTagName(aTagName);
}
NS_IMETHOD GetAttribute(const nsAReadableString& aName, nsAWritableString& aReturn) {
nsAutoString name(aName);
if (name.EqualsIgnoreCase("htmlfor")) {
return mInner.GetAttribute(NS_LITERAL_STRING("for"), aReturn);
}
return mInner.GetAttribute(aName, aReturn);
}
NS_IMETHOD SetAttribute(const nsAReadableString& aName, const nsAReadableString& aValue) {
nsAutoString name(aName);
if (name.EqualsIgnoreCase("htmlfor")) {
return mInner.SetAttribute(NS_LITERAL_STRING("for"), aValue);
}
return mInner.SetAttribute(aName, aValue);
}
NS_IMETHOD RemoveAttribute(const nsAReadableString& aName) {
nsAutoString name(aName);
if (name.EqualsIgnoreCase("htmlfor")) {
return mInner.RemoveAttribute(NS_LITERAL_STRING("for"));
}
return mInner.RemoveAttribute(aName);
}
NS_IMETHOD GetAttributeNode(const nsAReadableString& aName,
nsIDOMAttr** aReturn) {
nsAutoString name(aName);
if (name.EqualsIgnoreCase("htmlfor")) {
return mInner.GetAttributeNode(NS_LITERAL_STRING("for"), aReturn);
}
return mInner.GetAttributeNode(aName, aReturn);
}
NS_IMETHOD SetAttributeNode(nsIDOMAttr* aNewAttr, nsIDOMAttr** aReturn) {
return mInner.SetAttributeNode(aNewAttr, aReturn);
}
NS_IMETHOD RemoveAttributeNode(nsIDOMAttr* aOldAttr, nsIDOMAttr** aReturn) {
return mInner.RemoveAttributeNode(aOldAttr, aReturn);
}
NS_IMETHOD GetElementsByTagName(const nsAReadableString& aTagname,
nsIDOMNodeList** aReturn) {
return mInner.GetElementsByTagName(aTagname, aReturn);
}
NS_IMETHOD GetAttributeNS(const nsAReadableString& aNamespaceURI,
const nsAReadableString& aLocalName, nsAWritableString& aReturn) {
return mInner.GetAttributeNS(aNamespaceURI, aLocalName, aReturn);
}
NS_IMETHOD SetAttributeNS(const nsAReadableString& aNamespaceURI,
const nsAReadableString& aQualifiedName,
const nsAReadableString& aValue) {
return mInner.SetAttributeNS(aNamespaceURI, aQualifiedName, aValue);
}
NS_IMETHOD RemoveAttributeNS(const nsAReadableString& aNamespaceURI,
const nsAReadableString& aLocalName) {
return mInner.RemoveAttributeNS(aNamespaceURI, aLocalName);
}
NS_IMETHOD GetAttributeNodeNS(const nsAReadableString& aNamespaceURI,
const nsAReadableString& aLocalName,
nsIDOMAttr** aReturn) {
return mInner.GetAttributeNodeNS(aNamespaceURI, aLocalName, aReturn);
}
NS_IMETHOD SetAttributeNodeNS(nsIDOMAttr* aNewAttr, nsIDOMAttr** aReturn) {
return mInner.SetAttributeNodeNS(aNewAttr, aReturn);
}
NS_IMETHOD GetElementsByTagNameNS(const nsAReadableString& aNamespaceURI,
const nsAReadableString& aLocalName,
nsIDOMNodeList** aReturn) {
return mInner.GetElementsByTagNameNS(aNamespaceURI, aLocalName, aReturn);
}
NS_IMETHOD HasAttribute(const nsAReadableString& aName, PRBool* aReturn) {
return HasAttribute(aName, aReturn);
}
NS_IMETHOD HasAttributeNS(const nsAReadableString& aNamespaceURI,
const nsAReadableString& aLocalName, PRBool* aReturn) {
return mInner.HasAttributeNS(aNamespaceURI, aLocalName, aReturn);
}
// nsIDOMHTMLElement
NS_IMPL_IDOMHTMLELEMENT_USING_GENERIC(mInner)
// nsIDOMHTMLLabelElement
NS_DECL_IDOMHTMLLABELELEMENT
NS_IMETHOD SetForm(nsIDOMHTMLFormElement* aForm);
// nsIJSScriptObject
NS_IMPL_IJSSCRIPTOBJECT_USING_GENERIC(mInner)
// nsIContent
NS_IMPL_ICONTENT_NO_SETPARENT_NO_SETDOCUMENT_USING_GENERIC(mInner)
// nsIHTMLContent
NS_IMPL_IHTMLCONTENT_USING_GENERIC(mInner)
// nsIFormControl
NS_IMETHOD GetType(PRInt32* aType) { return NS_FORM_LABEL; }
NS_IMETHOD Init() { return NS_OK; }
protected:
nsGenericHTMLContainerFormElement mInner;
nsIForm* mForm;
};
// construction, destruction
nsresult
NS_NewHTMLLabelElement(nsIHTMLContent** aInstancePtrResult,
nsINodeInfo *aNodeInfo)
{
NS_ENSURE_ARG_POINTER(aInstancePtrResult);
NS_ENSURE_ARG_POINTER(aNodeInfo);
nsIHTMLContent* it = new nsHTMLLabelElement(aNodeInfo);
if (nsnull == it) {
return NS_ERROR_OUT_OF_MEMORY;
}
return it->QueryInterface(kIHTMLContentIID, (void**) aInstancePtrResult);
}
nsHTMLLabelElement::nsHTMLLabelElement(nsINodeInfo *aNodeInfo)
{
NS_INIT_REFCNT();
mInner.Init(this, aNodeInfo);
mForm = nsnull;
}
nsHTMLLabelElement::~nsHTMLLabelElement()
{
// Null out form's pointer to us - no ref counting here!
SetForm(nsnull);
}
// nsISupports
NS_IMPL_ADDREF(nsHTMLLabelElement)
NS_IMPL_RELEASE(nsHTMLLabelElement)
nsresult
nsHTMLLabelElement::QueryInterface(REFNSIID aIID, void** aInstancePtr)
{
NS_IMPL_HTML_CONTENT_QUERY_INTERFACE(aIID, aInstancePtr, this)
if (aIID.Equals(kIDOMHTMLLabelElementIID)) {
*aInstancePtr = (void*)(nsIDOMHTMLLabelElement*)this;
NS_ADDREF_THIS();
return NS_OK;
}
else if (aIID.Equals(kIFormControlIID)) {
*aInstancePtr = (void*)(nsIFormControl*) this;
NS_ADDREF_THIS();
return NS_OK;
}
return NS_NOINTERFACE;
}
// nsIDOMHTMLLabelElement
nsresult
nsHTMLLabelElement::CloneNode(PRBool aDeep, nsIDOMNode** aReturn)
{
nsHTMLLabelElement* it = new nsHTMLLabelElement(mInner.mNodeInfo);
if (nsnull == it) {
return NS_ERROR_OUT_OF_MEMORY;
}
nsCOMPtr<nsIDOMNode> kungFuDeathGrip(it);
mInner.CopyInnerTo(this, &it->mInner, aDeep);
return it->QueryInterface(kIDOMNodeIID, (void**) aReturn);
}
// nsIContent
NS_IMETHODIMP
nsHTMLLabelElement::SetParent(nsIContent* aParent)
{
return mInner.SetParentForFormControls(aParent, this, mForm);
}
NS_IMETHODIMP
nsHTMLLabelElement::SetDocument(nsIDocument* aDocument, PRBool aDeep, PRBool aCompileEventHandlers)
{
return mInner.SetDocumentForFormControls(aDocument, aDeep, aCompileEventHandlers, this, mForm);
}
NS_IMETHODIMP
nsHTMLLabelElement::GetForm(nsIDOMHTMLFormElement** aForm)
{
nsresult result = NS_OK;
*aForm = nsnull;
if (nsnull != mForm) {
nsIDOMHTMLFormElement* formElem = nsnull;
result = mForm->QueryInterface(kIDOMHTMLFormElementIID, (void**)&formElem);
if (NS_OK == result) {
*aForm = formElem;
}
}
return result;
}
NS_IMETHODIMP
nsHTMLLabelElement::SetForm(nsIDOMHTMLFormElement* aForm)
{
nsCOMPtr<nsIFormControl> formControl;
nsresult result = QueryInterface(kIFormControlIID, getter_AddRefs(formControl));
if (NS_FAILED(result)) formControl = nsnull;
nsAutoString nameVal, idVal;
mInner.GetAttribute(kNameSpaceID_None, nsHTMLAtoms::name, nameVal);
mInner.GetAttribute(kNameSpaceID_None, nsHTMLAtoms::id, idVal);
if (mForm && formControl) {
mForm->RemoveElement(formControl);
if (nameVal.Length())
mForm->RemoveElementFromTable(this, nameVal);
if (idVal.Length())
mForm->RemoveElementFromTable(this, idVal);
}
if (aForm) {
nsCOMPtr<nsIForm> theForm = do_QueryInterface(aForm, &result);
mForm = theForm; // Even if we fail, update mForm (nsnull in failure)
if ((NS_OK == result) && theForm) {
if (formControl) {
theForm->AddElement(formControl);
if (nameVal.Length())
theForm->AddElementToTable(this, nameVal);
if (idVal.Length())
theForm->AddElementToTable(this, idVal);
}
}
} else {
mForm = nsnull;
}
mInner.SetForm(mForm);
return result;
}
NS_IMPL_STRING_ATTR(nsHTMLLabelElement, AccessKey, accesskey)
//NS_IMPL_STRING_ATTR(nsHTMLLabelElement, HtmlFor, _for)
NS_IMETHODIMP
nsHTMLLabelElement::GetHtmlFor(nsAWritableString& aValue)
{
mInner.GetAttribute(kNameSpaceID_HTML, nsHTMLAtoms::_for, aValue);
return NS_OK;
}
NS_IMETHODIMP
nsHTMLLabelElement::SetHtmlFor(const nsAReadableString& aValue)
{
// trim leading and trailing whitespace
static char whitespace[] = " \r\n\t";
nsAutoString value(aValue);
value.Trim(whitespace, PR_TRUE, PR_TRUE);
return mInner.SetAttribute(kNameSpaceID_HTML, nsHTMLAtoms::_for, value, PR_TRUE);
}
NS_IMETHODIMP
nsHTMLLabelElement::StringToAttribute(nsIAtom* aAttribute,
const nsAReadableString& aValue,
nsHTMLValue& aResult)
{
return NS_CONTENT_ATTR_NOT_THERE;
}
NS_IMETHODIMP
nsHTMLLabelElement::AttributeToString(nsIAtom* aAttribute,
const nsHTMLValue& aValue,
nsAWritableString& aResult) const
{
return mInner.AttributeToString(aAttribute, aValue, aResult);
}
static void
MapAttributesInto(const nsIHTMLMappedAttributes* aAttributes,
nsIMutableStyleContext* aContext,
nsIPresContext* aPresContext)
{
nsGenericHTMLElement::MapCommonAttributesInto(aAttributes, aContext, aPresContext);
}
NS_IMETHODIMP
nsHTMLLabelElement::GetMappedAttributeImpact(const nsIAtom* aAttribute,
PRInt32& aHint) const
{
if (! nsGenericHTMLElement::GetCommonMappedAttributesImpact(aAttribute, aHint)) {
aHint = NS_STYLE_HINT_CONTENT;
}
return NS_OK;
}
NS_IMETHODIMP
nsHTMLLabelElement::GetAttributeMappingFunctions(nsMapAttributesFunc& aFontMapFunc,
nsMapAttributesFunc& aMapFunc) const
{
aFontMapFunc = nsnull;
aMapFunc = &MapAttributesInto;
return NS_OK;
}
NS_IMETHODIMP
nsHTMLLabelElement::HandleDOMEvent(nsIPresContext* aPresContext,
nsEvent* aEvent,
nsIDOMEvent** aDOMEvent,
PRUint32 aFlags,
nsEventStatus* aEventStatus)
{
NS_ENSURE_ARG_POINTER(aEventStatus);
nsresult rv = mInner.HandleDOMEvent(aPresContext, aEvent, aDOMEvent,
aFlags, aEventStatus);
// Now a little special trickery because we are a label:
// We need to pass this event on to our child iff it is a focus,
// keypress/up/dn, mouseclick/dblclick/up/down.
if ((NS_OK == rv) && (NS_EVENT_FLAG_INIT & aFlags) &&
((nsEventStatus_eIgnore == *aEventStatus) ||
(nsEventStatus_eConsumeNoDefault == *aEventStatus)) ) {
PRBool isFormElement = PR_FALSE;
nsCOMPtr<nsIHTMLContent> node; // Node we are a label for
switch (aEvent->message) {
case NS_FOCUS_CONTENT:
// Bug 49897: According to the spec, the following should not be passed
// Bug 7554: Despite the spec, IE passes left click events, so for compatability:
case NS_MOUSE_LEFT_CLICK:
// case NS_MOUSE_LEFT_DOUBLECLICK:
// case NS_MOUSE_LEFT_BUTTON_UP:
// case NS_MOUSE_LEFT_BUTTON_DOWN:
// case NS_MOUSE_MIDDLE_CLICK:
// case NS_MOUSE_MIDDLE_DOUBLECLICK:
// case NS_MOUSE_MIDDLE_BUTTON_UP:
// case NS_MOUSE_MIDDLE_BUTTON_DOWN:
// case NS_MOUSE_RIGHT_CLICK:
// case NS_MOUSE_RIGHT_DOUBLECLICK:
// case NS_MOUSE_RIGHT_BUTTON_UP:
// case NS_MOUSE_RIGHT_BUTTON_DOWN:
// case NS_KEY_PRESS:
// case NS_KEY_UP:
// case NS_KEY_DOWN:
{
// Get the element that this label is for
nsAutoString elementId;
rv = GetHtmlFor(elementId);
if (NS_SUCCEEDED(rv) && elementId.Length()) { // --- We have a FOR attr
nsCOMPtr<nsIDocument> iDoc;
rv = mInner.GetDocument(*getter_AddRefs(iDoc));
if (NS_SUCCEEDED(rv)) {
nsCOMPtr<nsIDOMElement> domElement;
// XXX This should be merged into nsIDocument
nsCOMPtr<nsIDOMHTMLDocument> htmlDoc = do_QueryInterface(iDoc, &rv);
if (NS_SUCCEEDED(rv) && htmlDoc) {
rv = htmlDoc->GetElementById(elementId, getter_AddRefs(domElement));
}
#ifdef INCLUDE_XUL
else {
nsCOMPtr<nsIDOMXULDocument> xulDoc = do_QueryInterface(iDoc, &rv);
if (NS_SUCCEEDED(rv) && xulDoc) {
rv = xulDoc->GetElementById(elementId, getter_AddRefs(domElement));
}
}
#endif // INCLUDE_XUL
if (NS_SUCCEEDED(rv) && domElement) {
// Get our grubby paws on the content interface
node = do_QueryInterface(domElement, &rv);
// Find out of this is a form element.
if (NS_SUCCEEDED(rv)) {
nsIFormControlFrame* control;
nsresult gotFrame = nsGenericHTMLElement::GetPrimaryFrame(node, control);
isFormElement = NS_SUCCEEDED(gotFrame) && control;
}
}
}
} else { // --- No FOR attribute, we are a label for our first child element
PRInt32 numNodes;
rv = mInner.ChildCount(numNodes);
if (NS_SUCCEEDED(rv)) {
nsCOMPtr<nsIContent> contNode;
PRInt32 i;
for (i = 0; NS_SUCCEEDED(rv) && !isFormElement && (i < numNodes); i++) {
rv = ChildAt(i, *getter_AddRefs(contNode));
if (NS_SUCCEEDED(rv) && contNode) {
// We need to make sure this child is a form element
nsresult isHTMLContent = PR_FALSE;
node = do_QueryInterface(contNode, &isHTMLContent);
if (NS_SUCCEEDED(isHTMLContent) && node) {
// Find out of this is a form element.
nsIFormControlFrame* control;
nsresult gotFrame = nsGenericHTMLElement::GetPrimaryFrame(node, control);
isFormElement = NS_SUCCEEDED(gotFrame) && control;
}
}
}
}
}
} // Close should handle
} // Close switch
// If we found an element, pass along the event to it.
if (NS_SUCCEEDED(rv) && node) {
// Only pass along event if this is a form element
if (isFormElement) {
rv = node->HandleDOMEvent(aPresContext, aEvent, aDOMEvent, aFlags, aEventStatus);
}
}
} // Close trickery
return rv;
}
NS_IMETHODIMP
nsHTMLLabelElement::SizeOf(nsISizeOfHandler* aSizer, PRUint32* aResult) const
{
if (!aResult) return NS_ERROR_NULL_POINTER;
#ifdef DEBUG
mInner.SizeOf(aSizer, aResult, sizeof(*this));
if (mForm) {
PRBool recorded;
aSizer->RecordObject(mForm, &recorded);
if (!recorded) {
PRUint32 formSize;
mForm->SizeOf(aSizer, &formSize);
aSizer->AddSize(nsHTMLAtoms::iform, formSize);
}
}
#endif
return NS_OK;
}