org.apache.batik.dom.svg

Interface SVGSVGContext

public interface SVGSVGContext extends SVGContext

Context class for svg:svg elements. Eventually this interface will likely have a number of other methods but for now it will have methods to do intersection and enclosure checking.
Method Summary
booleananimationsPaused()
Returns whether animations are currently paused.
booleancheckEnclosure(Element element, SVGRect rect)
Returns true if the given DOM element is enclosed in the svgRect.
booleancheckIntersection(Element element, SVGRect rect)
Returns true if the given DOM element intersects svgRect.
voiddeselectAll()
Used to inform the user agent that the text selection should be cleared.
voidforceRedraw()
Forces an immediate redraw of the canvas.
floatgetCurrentTime()
Returns the current document time.
ListgetEnclosureList(SVGRect rect, Element end)
Returns a List of all the DOM elements that are encosed in svgRect that are below end in the rendering order.
ListgetIntersectionList(SVGRect svgRect, Element end)
Returns a List of all the DOM elements that intersect svgRect that are below end in the rendering order.
voidpauseAnimations()
Pauses animations in the document.
voidsetCurrentTime(float t)
Sets the current document time.
intsuspendRedraw(int max_wait_milliseconds)
Suspends redrawing of the canvas for the given number of milliseconds.
voidunpauseAnimations()
Unpauses animations in the document.
booleanunsuspendRedraw(int suspend_handle_id)
Unsuspends redrawing of the canvas.
voidunsuspendRedrawAll()
Unsuspends redrawing of the canvas.

Method Detail

animationsPaused

public boolean animationsPaused()
Returns whether animations are currently paused.

checkEnclosure

public boolean checkEnclosure(Element element, SVGRect rect)
Returns true if the given DOM element is enclosed in the svgRect.

checkIntersection

public boolean checkIntersection(Element element, SVGRect rect)
Returns true if the given DOM element intersects svgRect.

deselectAll

public void deselectAll()
Used to inform the user agent that the text selection should be cleared.

forceRedraw

public void forceRedraw()
Forces an immediate redraw of the canvas.

getCurrentTime

public float getCurrentTime()
Returns the current document time.

getEnclosureList

public List getEnclosureList(SVGRect rect, Element end)
Returns a List of all the DOM elements that are encosed in svgRect that are below end in the rendering order.

getIntersectionList

public List getIntersectionList(SVGRect svgRect, Element end)
Returns a List of all the DOM elements that intersect svgRect that are below end in the rendering order.

pauseAnimations

public void pauseAnimations()
Pauses animations in the document.

setCurrentTime

public void setCurrentTime(float t)
Sets the current document time.

suspendRedraw

public int suspendRedraw(int max_wait_milliseconds)
Suspends redrawing of the canvas for the given number of milliseconds.

unpauseAnimations

public void unpauseAnimations()
Unpauses animations in the document.

unsuspendRedraw

public boolean unsuspendRedraw(int suspend_handle_id)
Unsuspends redrawing of the canvas.

unsuspendRedrawAll

public void unsuspendRedrawAll()
Unsuspends redrawing of the canvas.
Copyright B) 2007 Apache Software Foundation. All Rights Reserved.