com.yworks.yfiles.view

Class PrepareRenderContextEventArgs

java.lang.Object

com.yworks.yfiles.view.RoutedEventArgs

com.yworks.yfiles.view.PrepareRenderContextEventArgs

All Implemented Interfaces:

IEventArgs

public class PrepareRenderContextEventArgs
extends RoutedEventArgs

The event arguments for the IEventHandler used by CanvasControl#raisePrepareRenderContextEvent(PrepareRenderContextEventArgs).

This event argument can be used to modify the Context during CanvasControl.exportContent(IRenderContext) and CanvasControl.invalidate()

See Also:

CanvasControl#addPrepareRenderContextListener(com.yworks.yfiles.utils.IEventHandler)

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEventArgs

EMPTY

Constructor Summary

Constructors

Constructor and Description
PrepareRenderContextEventArgs(IRenderContext context) Initializes a new instance of the PrepareRenderContextEventArgs class.

Method Summary

Modifier and Type	Method and Description
IRenderContext	getContext() Gets the context.
void	setContext(IRenderContext value) Sets the context.

Methods inherited from class com.yworks.yfiles.view.RoutedEventArgs

getOriginalSource, isHandled, setHandled

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrepareRenderContextEventArgs

public PrepareRenderContextEventArgs(IRenderContext context)

Initializes a new instance of the PrepareRenderContextEventArgs class.

Parameters:

context - The initial context which can be modified by the event handlers using the Context property.

Method Detail

getContext

public final IRenderContext getContext()

Gets the context.

Throws:

NullPointerException - If the argument is null.

Returns:

The context that can be modified, wrapped, or exchanged by the event handlers. This value may not be null.

See Also:

setContext(IRenderContext)

setContext

public final void setContext(IRenderContext value)

Sets the context.

Throws:

NullPointerException - If the argument is null.

Parameters:

value - The context that can be modified, wrapped, or exchanged by the event handlers. This value may not be null.

See Also:

getContext()