com.yworks.yfiles.view

Class RenderContextEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

com.yworks.yfiles.view.RenderContextEvent

All Implemented Interfaces:

IEventArgs, Serializable, Cloneable

public class RenderContextEvent
extends Event
implements IEventArgs

The event arguments for the com.yworks.util.IEventHandler used by PrepareRenderContextEvent.

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

See Also:

CanvasControl#addPrepareRenderContextListener(com.yworks.util.IEventHandler), Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static EventType<RenderContextEvent>	ANY Common supertype for all render context event types.
static EventType<RenderContextEvent>	PREPARE Event type for the event that can be used to modify the getContext() during com.yworks.yfiles.canvas.CanvasControl#createContentVisual(com.yworks.yfiles.drawing.IRenderContext) and com.yworks.yfiles.canvas.CanvasControl#update().

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
RenderContextEvent(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 javafx.event.Event

clone, consume, copyFor, fireEvent, getEventType, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final EventType<RenderContextEvent> ANY

Common supertype for all render context event types.

PREPARE

public static final EventType<RenderContextEvent> PREPARE

Event type for the event that can be used to modify the getContext() during com.yworks.yfiles.canvas.CanvasControl#createContentVisual(com.yworks.yfiles.drawing.IRenderContext) and com.yworks.yfiles.canvas.CanvasControl#update().

Constructor Detail

RenderContextEvent

public RenderContextEvent(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()