com.yworks.yfiles.graphml

Class QueryReferenceIdEventArgs

java.lang.Object

com.yworks.yfiles.graphml.QueryReferenceIdEventArgs

All Implemented Interfaces:

IEventArgs

public class QueryReferenceIdEventArgs
extends Object
implements IEventArgs

Event arguments for calls to the QueryReferenceId or QueryReferenceId events.

Event handling code should inspect the Value property and decide whether to set the ReferenceId and/or ReferenceType property in order to handle the event.

See Also:

GraphMLIOHandler.addQueryReferenceIdListener(com.yworks.yfiles.utils.IEventHandler), GraphMLWriter.addQueryReferenceIdListener(com.yworks.yfiles.utils.IEventHandler)

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
QueryReferenceIdEventArgs(IWriteContext context, Object value) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
IWriteContext	getContext() The current write context that can be used by the event handler for additional information.
String	getReferenceId() The reference id that should be evaluated by the event handler.
GraphMLReferenceType	getReferenceType() Determines the type of the reference being queried.
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	setReferenceId(String value) The reference id that should be evaluated by the event handler.
void	setReferenceType(GraphMLReferenceType value) Determines the type of the reference being queried.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryReferenceIdEventArgs

public QueryReferenceIdEventArgs(IWriteContext context,
                                 Object value)

Creates a new instance.

The Handled property is set to false, the ReferenceId is set to null.

Parameters:

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

value - The referenced object instance.

Method Detail

getContext

public final IWriteContext getContext()

The current write 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 be evaluated by the event handler.

Setting this property to a String that is not null and not empty automatically sets Handled to true.

Returns:

The ReferenceId.

See Also:

isHandled(), setReferenceId(String)

getReferenceType

public final GraphMLReferenceType getReferenceType()

Determines the type of the reference being queried.

Setting this property automatically sets Handled to true. By default this property is GraphMLReferenceType.EXTERNAL so Values that are given a ReferenceId are treated as external references that are not serialized to the GraphML. Setting this property to GraphMLReferenceType.INTERNAL and specifying a ReferenceId will make the reference mechanism use the provided reference but will cause it to serialize the value to the GraphML, nevertheless.

Returns:

The ReferenceType.

See Also:

getReferenceId(), isHandled(), setReferenceType(GraphMLReferenceType)

getValue

public final Object getValue()

The reference value that is encapsulated by this instance.

Returns:

The Value.

isHandled

public final boolean isHandled()

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

This property is set implicitly by ReferenceId.

Returns:

The Handled.

See Also:

getReferenceId()

setReferenceId

public final void setReferenceId(String value)

The reference id that should be evaluated by the event handler.

Setting this property to a String that is not null and not empty automatically sets Handled to true.

Parameters:

value - The ReferenceId to set.

See Also:

isHandled(), getReferenceId()

setReferenceType

public final void setReferenceType(GraphMLReferenceType value)

Determines the type of the reference being queried.

Setting this property automatically sets Handled to true. By default this property is GraphMLReferenceType.EXTERNAL so Values that are given a ReferenceId are treated as external references that are not serialized to the GraphML. Setting this property to GraphMLReferenceType.INTERNAL and specifying a ReferenceId will make the reference mechanism use the provided reference but will cause it to serialize the value to the GraphML, nevertheless.

Parameters:

value - The ReferenceType to set.

See Also:

getReferenceId(), isHandled(), getReferenceType()