com.yworks.yfiles.graphml

Class QueryOutputHandlersEventArgs

java.lang.Object

com.yworks.yfiles.graphml.QueryOutputHandlersEventArgs

All Implemented Interfaces:

IEventArgs

public final class QueryOutputHandlersEventArgs
extends Object
implements IEventArgs

Event argument implementation that is used by the QueryOutputHandlers event.

These event arguments can be used to add more IOutputHandler implementations to the GraphMLWriter dynamically at the time of writing, by adding them to the Handlers collection.

See Also:

GraphMLIOHandler

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
QueryOutputHandlersEventArgs(IWriteContext context, KeyScope scope) Initializes a new instance of the QueryOutputHandlersEventArgs class.

Method Summary

Modifier and Type	Method and Description
void	addOutputHandler(IOutputHandler handler) Adds the given output handler to the set of registered output handlers for the given scope.
IWriteContext	getContext() Gets the context for which the handlers are queried.
IEnumerable<IOutputHandler>	getHandlers() The IOutputHandlers that have been registered on this event argument instance so far.
KeyScope	getScope() The scope where the handlers should be added.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryOutputHandlersEventArgs

public QueryOutputHandlersEventArgs(IWriteContext context,
                                    KeyScope scope)

Initializes a new instance of the QueryOutputHandlersEventArgs class.

Parameters:

context - The context to assign to the Context property.

scope - The scope where the handlers should be added.

Method Detail

addOutputHandler

public final void addOutputHandler(IOutputHandler handler)

Adds the given output handler to the set of registered output handlers for the given scope.

Parameters:

handler - The handler to add.

getContext

public final IWriteContext getContext()

Gets the context for which the handlers are queried.

Returns:

The context of the query.

getHandlers

public final IEnumerable<IOutputHandler> getHandlers()

The IOutputHandlers that have been registered on this event argument instance so far.

Returns:

The Handlers.

getScope

public final KeyScope getScope()

The scope where the handlers should be added.

Returns:

The Scope.