com.yworks.yfiles.graphml

Class ResolveReferenceEventArgs

java.lang.Object

com.yworks.yfiles.graphml.ResolveReferenceEventArgs

All Implemented Interfaces:

IEventArgs

public class ResolveReferenceEventArgs
extends Object
implements IEventArgs

Event arguments for calls to the ResolveReference and OverrideResolveReference events.

See Also:

GraphMLIOHandler.addResolveReferenceListener(com.yworks.yfiles.utils.IEventHandler), GraphMLIOHandler.addOverrideResolveReferenceListener(com.yworks.yfiles.utils.IEventHandler)

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
ResolveReferenceEventArgs(IParseContext context, String referenceId) Creates a new instance of ResolveReferenceEventArgs.

Method Summary

Modifier and Type	Method and Description
IParseContext	getContext() The current parse context that can be used by the event handler for additional information.
String	getReferenceId() The reference id that should evaluated by the event handler.
Object	getValue() The reference value that is encapsulated by this instance.
boolean	isHandled() Returns whether the last event handler invocation has actually handled the event.
void	setValue(Object value) The reference value that is encapsulated by this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResolveReferenceEventArgs

public ResolveReferenceEventArgs(IParseContext context,
                                 String referenceId)

Creates a new instance of ResolveReferenceEventArgs.

The Handled property is set to false, the Value property is set to null

Parameters:

context - The current parse context that can be used by the event handler for additional information.

referenceId - The reference id that should evaluated by the event handler.

Method Detail

getContext

public final IParseContext getContext()

The current parse context that can be used by the event handler for additional information.

Returns:

The Context.

getReferenceId

public final String getReferenceId()

The reference id that should evaluated by the event handler.

Returns:

The ReferenceId.

getValue

public final Object getValue()

The reference value that is encapsulated by this instance.

Setting this property automatically sets Handled to true.

Returns:

The Value.

See Also:

isHandled(), setValue(Object)

isHandled

public final boolean isHandled()

Returns whether the last event handler invocation has actually handled the event.

This property is set implicitly by Value.

Returns:

The Handled.

See Also:

getValue()

setValue

public final void setValue(Object value)

The reference value that is encapsulated by this instance.

Setting this property automatically sets Handled to true.

Parameters:

value - The Value to set.

See Also:

isHandled(), getValue()