ilog.views.graphlayout.labellayout
Class LabelLayoutParameterEvent

java.lang.Object
  java.util.EventObject
      ilog.views.graphlayout.labellayout.LabelLayoutParameterEvent

All Implemented Interfaces:

Serializable

public final class LabelLayoutParameterEvent
extends EventObject

If you install a LabelLayoutParameterEventListener on a label layout instance, a LabelLayoutParameterEvent is delivered to the listener each time the method IlvLabelLayout.setParametersUpToDate(boolean) is called, that is, each time a layout parameter changes and each time the layout is successfully performed. This allows you to react when a layout parameter changes, for instance, to update a display that shows the current values of the layout parameters or to update a flag indicating whether the set of layout parameters must be saved to a file.

Since:

JViews 5.0

See Also:

LabelLayoutParameterEventListener, IlvLabelLayout.addLabelLayoutParameterEventListener(LabelLayoutParameterEventListener), IlvLabelLayout.setParametersUpToDate(boolean), Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

LabelLayoutParameterEvent(IlvLabelLayout layout, boolean parametersUpToDate)
Creates the event.

Method Summary

IlvLabelLayout	getLabelLayout() Returns the label layout instance of the event.
boolean	isParametersUpToDate() Returns true if IlvLabelLayout.setParametersUpToDate(boolean) was called with a true argument.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelLayoutParameterEvent

public LabelLayoutParameterEvent(IlvLabelLayout layout,
                                 boolean parametersUpToDate)

Creates the event.

Parameters:

layout - The layout instance source of the event.

parametersUpToDate - true if the label layout parameters are set up-to-date; false if a layout parameter changed.

Method Detail

getLabelLayout

public IlvLabelLayout getLabelLayout()

Returns the label layout instance of the event.

isParametersUpToDate

public boolean isParametersUpToDate()

Returns true if IlvLabelLayout.setParametersUpToDate(boolean) was called with a true argument. This usually happens only after the layout was successfully performed.
Returns false if IlvLabelLayout.setParametersUpToDate(boolean) was called with a false argument. This usually happens when a label layout parameter changed.

See Also:

IlvLabelLayout.performLayout(), IlvLabelLayout.setParametersUpToDate(boolean)