com.yworks.yfiles.layout

Class LayoutEventArgs

java.lang.Object

com.yworks.yfiles.layout.LayoutEventArgs

All Implemented Interfaces:

IEventArgs

public final class LayoutEventArgs
extends Object
implements IEventArgs

This event argument is used by LayoutFinished event.

Field Summary

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
LayoutEventArgs() Initializes a new instance of the LayoutEventArgs class.
LayoutEventArgs(RuntimeException exception) Initializes a new instance of the LayoutEventArgs class.

Method Summary

Modifier and Type	Method and Description
RuntimeException	getException() Gets the exception this event is signaling, if the event was caused by an exception.
boolean	isHandled() Mark an event as handled.
void	setHandled(boolean value) Mark an event as handled.

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutEventArgs

public LayoutEventArgs()

Initializes a new instance of the LayoutEventArgs class.

LayoutEventArgs

public LayoutEventArgs(RuntimeException exception)

Initializes a new instance of the LayoutEventArgs class.

Parameters:

exception - The exception to pass to Exception.

Method Detail

getException

public final RuntimeException getException()

Gets the exception this event is signaling, if the event was caused by an exception.

Returns:

The exception.

isHandled

public final boolean isHandled()

Mark an event as handled.

In order to prevent further processing, the event needs to be marked as handled.

Note that setting this to true doesn't prevent other event handlers from being called. These must check for this flag explicitly.

Returns:

The Handled.

See Also:

setHandled(boolean)

setHandled

public final void setHandled(boolean value)

Mark an event as handled.

In order to prevent further processing, the event needs to be marked as handled.

Note that setting this to true doesn't prevent other event handlers from being called. These must check for this flag explicitly.

Parameters:

value - The Handled to set.

See Also:

isHandled()