nsIAccessNode Interface Reference

import "nsIAccessNode.idl";

Inheritance diagram for nsIAccessNode:

Collaboration diagram for nsIAccessNode:

Detailed Description

When accessibility is active in Gecko, every DOM node can have one nsIAccessNode for each pres shell the DOM node is rendered in. The nsIAccessNode implementations are instantiated lazily. The nsIAccessNode tree for a given dom window has a one to one relationship to the DOM tree. If the DOM node for this access node is "accessible", then a QueryInterface to nsIAccessible will succeed.

Status:: UNDER_REVIEW


Public Member Functions
nsIAccessNode	getChildNodeAt (in long childNum)
	Get the nth child of this node.
void	scrollTo (in unsigned long aScrollType)
	Makes an object visible on screen.
void	scrollToPoint (in unsigned long aCoordinateType, in long aX, in long aY)
	Moves the top left of an object to a specified location.
DOMString	getComputedStyleValue (in DOMString pseudoElt, in DOMString propertyName)
	Retrieve the computed style value for this DOM node, if it is a DOM element.
nsIDOMCSSPrimitiveValue	getComputedStyleCSSValue (in DOMString pseudoElt, in DOMString propertyName)
	The method is similar to getComputedStyleValue() excepting that this one returns nsIDOMCSSPrimitiveValue.
Public Attributes
readonly attribute nsIDOMNode	DOMNode
	The DOM node this nsIAccessNode is associated with.
readonly attribute long	numChildren
	The number of DOM children for the DOM node, which matches the number of nsIAccessNode children for this nsIAccessNode.
readonly attribute nsIAccessNode	parentNode
	The parent nsIAccessNode.
readonly attribute nsIAccessNode	firstChildNode
	The first nsIAccessNode child.
readonly attribute nsIAccessNode	lastChildNode
	The last nsIAccessNode child.
readonly attribute nsIAccessNode	previousSiblingNode
	The previous nsIAccessNode sibling.
readonly attribute nsIAccessNode	nextSiblingNode
	The next nsIAccessNode sibling.
readonly attribute nsIAccessibleDocument	accessibleDocument
	The nsIAccessibleDocument that this nsIAccessNode resides in.
readonly attribute DOMString	innerHTML
	The innerHTML for the DOM node This is a text string of all the markup inside the DOM node, not including the start and end tag for the node.
readonly attribute voidPtr	ownerWindow
	The OS window handle for the window this node is being displayed in.
readonly attribute voidPtr	uniqueID
	A unique ID calculated for this DOM node, for the purposes of caching and referencing this object.
readonly attribute DOMString	language
	The language for the current DOM node, e.g.

Member Function Documentation

nsIAccessNode nsIAccessNode::getChildNodeAt ( in long childNum )

Parameters:

childNum

Zero-based child index

Returns:: The nth nsIAccessNode child

void nsIAccessNode::scrollTo ( in unsigned long aScrollType )

Parameters:

scrollType

- defines where the object should be placed on the screen (see nsIAccessibleScrollType for available constants).

void nsIAccessNode::scrollToPoint	(	in unsigned long	aCoordinateType,
		in long	aX,
		in long	aY
	)

Parameters:

	coordinateType	- specifies whether the coordinates are relative to the screen or the parent object (for available constants refer to nsIAccessibleCoordinateType)
	aX	- defines the x coordinate
	aY	- defines the y coordinate

DOMString nsIAccessNode::getComputedStyleValue	(	in DOMString	pseudoElt,
		in DOMString	propertyName
	)

Note: the meanings of width, height and other size measurements depend on the version of CSS being used. Therefore, for bounds information, it is better to use nsIAccessible::accGetBounds.

Parameters:

	pseudoElt	The pseudo element to retrieve style for, or NULL for general computed style information for this node.
	propertyName	Retrieve the computed style value for this property name, for example "border-bottom".