com.yworks.yfiles.graphml

Class QueryInputHandlersEventArgs

java.lang.Object

com.yworks.yfiles.graphml.QueryInputHandlersEventArgs

All Implemented Interfaces:

IEventArgs

public final class QueryInputHandlersEventArgs
extends Object
implements IEventArgs

Specialized IEventArgs that are used for dynamic IInputHandler registration.

See Also:

GraphMLIOHandler.addQueryInputHandlersListener(com.yworks.yfiles.utils.IEventHandler), GraphMLParser.addQueryInputHandlersListener(com.yworks.yfiles.utils.IEventHandler)

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
QueryInputHandlersEventArgs(IParseContext context, Element keyDefinition, List<IInputHandler> handlers) Create a new instance.

Method Summary

Modifier and Type	Method and Description
void	addInputHandler(IInputHandler handler) Register an IInputHandler instance for the current KeyDefinition.
IParseContext	getContext() The IParseContext instance that can queried for further information.
IEnumerable<IInputHandler>	getHandlers() The IInputHandlers that have been registered on this event argument instance so far.
Element	getKeyDefinition() The key definition of the GraphML attribute.
boolean	isHandled() Gets or query whether the current GraphML attribute has been processed.
void	setHandled(boolean value) Sets or query whether the current GraphML attribute has been processed.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryInputHandlersEventArgs

public QueryInputHandlersEventArgs(IParseContext context,
                                   Element keyDefinition,
                                   List<IInputHandler> handlers)

Create a new instance.

Parameters:

context - The current parse context.

keyDefinition - The current key definition

handlers - Stores the registered IInputHandler instances.

Method Detail

addInputHandler

public final void addInputHandler(IInputHandler handler)

Register an IInputHandler instance for the current KeyDefinition.

Calling this method automatically sets Handled to true.

getContext

public final IParseContext getContext()

The IParseContext instance that can queried for further information.

Returns:

The Context.

getHandlers

public final IEnumerable<IInputHandler> getHandlers()

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

Returns:

The Handlers.

getKeyDefinition

public final Element getKeyDefinition()

The key definition of the GraphML attribute.

This XML element should be queried to determine if an IInputHandler should be registered with addInputHandler(IInputHandler)

Returns:

The KeyDefinition.

isHandled

public final boolean isHandled()

Gets or query whether the current GraphML attribute has been processed.

This is automatically set by calling addInputHandler(IInputHandler), so it should be seldom necessary to set this property manually.

Returns:

The Handled.

See Also:

setHandled(boolean)

setHandled

public final void setHandled(boolean value)

Sets or query whether the current GraphML attribute has been processed.

This is automatically set by calling addInputHandler(IInputHandler), so it should be seldom necessary to set this property manually.

Parameters:

value - The Handled to set.

See Also:

isHandled()