Public Member Functions | Public Attributes

nsIHTMLAbsPosEditor Interface Reference

import "nsIHTMLAbsPosEditor.idl";

Collaboration diagram for nsIHTMLAbsPosEditor:

List of all members.

Public Member Functions

void absolutePositionSelection (in boolean aEnabled)
 extracts the selection from the normal flow of the document and positions it.
void relativeChangeZIndex (in long aChange)
 adds aChange to the z-index of the currently positioned element.
void absolutelyPositionElement (in nsIDOMElement aElement, in boolean aEnabled)
 extracts an element from the normal flow of the document and positions it, and puts it back in the normal flow.
void setElementPosition (in nsIDOMElement aElement, in long aX, in long aY)
 sets the position of an element; warning it does NOT check if the element is already positioned or not and that's on purpose.
long getElementZIndex (in nsIDOMElement aElement)
 returns the absolute z-index of a positioned element.
void setElementZIndex (in nsIDOMElement aElement, in long aZorder)
 sets the z-index of an element.
long relativeChangeElementZIndex (in nsIDOMElement aElement, in long aChange)
 adds aChange to the z-index of an arbitrary element.
void showGrabberOnElement (in nsIDOMElement aElement)
 shows a grabber attached to an arbitrary element.
void hideGrabber ()
 hide the grabber if it shown.
void refreshGrabber ()
 refreshes the grabber if it shown, possibly updating its position or even hiding it.

Public Attributes

readonly attribute boolean selectionContainerAbsolutelyPositioned
 true if the selection container is absolutely positioned
readonly attribute nsIDOMElement positionedElement
 this contains the absolutely positioned element currently edited or null
attribute boolean absolutePositioningEnabled
 true if Absolute Positioning handling is enabled in the editor
attribute boolean snapToGridEnabled
 true if Snap To Grid is enabled in the editor.
attribute unsigned long gridSize
 sets the grid size in pixels.
readonly attribute nsIDOMElement absolutelyPositionedSelectionContainer
 returns the deepest absolutely positioned container of the selection if it exists or null.

Member Function Documentation

void nsIHTMLAbsPosEditor::absolutelyPositionElement ( in nsIDOMElement  aElement,
in boolean  aEnabled 
)

extracts an element from the normal flow of the document and positions it, and puts it back in the normal flow.

Parameters:
aElement [IN] the element
aEnabled [IN] true to absolutely position the element, false to put it back in the normal flow
void nsIHTMLAbsPosEditor::absolutePositionSelection ( in boolean  aEnabled  ) 

extracts the selection from the normal flow of the document and positions it.

Parameters:
aEnabled [IN] true to absolutely position the selection, false to put it back in the normal flow
long nsIHTMLAbsPosEditor::getElementZIndex ( in nsIDOMElement  aElement  ) 

returns the absolute z-index of a positioned element.

Never returns 'auto'.

Returns:
the z-index of the element
Parameters:
aElement [IN] the element.
void nsIHTMLAbsPosEditor::hideGrabber (  ) 

hide the grabber if it shown.

void nsIHTMLAbsPosEditor::refreshGrabber (  ) 

refreshes the grabber if it shown, possibly updating its position or even hiding it.

long nsIHTMLAbsPosEditor::relativeChangeElementZIndex ( in nsIDOMElement  aElement,
in long  aChange 
)

adds aChange to the z-index of an arbitrary element.

Returns:
the new z-index of the element
Parameters:
aElement [IN] the element
aChange [IN] relative change to apply to current z-index of the element
void nsIHTMLAbsPosEditor::relativeChangeZIndex ( in long  aChange  ) 

adds aChange to the z-index of the currently positioned element.

Parameters:
aChange [IN] relative change to apply to current z-index
void nsIHTMLAbsPosEditor::setElementPosition ( in nsIDOMElement  aElement,
in long  aX,
in long  aY 
)

sets the position of an element; warning it does NOT check if the element is already positioned or not and that's on purpose.

Parameters:
aElement [IN] the element
aX [IN] the x position in pixels.
aY [IN] the y position in pixels.
void nsIHTMLAbsPosEditor::setElementZIndex ( in nsIDOMElement  aElement,
in long  aZorder 
)

sets the z-index of an element.

Parameters:
aElement [IN] the element
aZorder [IN] the z-index
void nsIHTMLAbsPosEditor::showGrabberOnElement ( in nsIDOMElement  aElement  ) 

shows a grabber attached to an arbitrary element.

The grabber is an image positioned on the left hand side of the top border of the element. Dragging and dropping it allows to change the element's absolute position in the document. See chrome://editor/content/images/grabber.gif

Parameters:
aElement [IN] the element

Member Data Documentation

returns the deepest absolutely positioned container of the selection if it exists or null.

true if Absolute Positioning handling is enabled in the editor

attribute unsigned long nsIHTMLAbsPosEditor::gridSize

sets the grid size in pixels.

Parameters:
aSizeInPixels [IN] the size of the grid in pixels

this contains the absolutely positioned element currently edited or null

true if the selection container is absolutely positioned

true if Snap To Grid is enabled in the editor.


The documentation for this interface was generated from the following file: