ilog.views.hypergraph

Class IlvDefaultHyperEdgeEnd

java.lang.Object

ilog.views.hypergraph.IlvDefaultHyperEdgeEnd

All Implemented Interfaces:

IlvHyperEdgeEnd, IlvPersistentObject

Direct Known Subclasses:

IlvSegmentedHyperEdge.HyperEdgeEnd

public class IlvDefaultHyperEdgeEnd
extends Object
implements IlvHyperEdgeEnd

IlvDefaultHyperEdgeEnd is the default implementation of the end point of a hyperedge at a node.

Since:

JViews 8.0

See Also:

IlvHyperEdge

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IlvDefaultHyperEdgeEnd(IlvHyperEdge edge, IlvGraphic node) Creates a new hyperedge end point at the input node.
	IlvDefaultHyperEdgeEnd(IlvInputStream stream) Reads the object from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
IlvHyperEdgeEnd	copy() Creates a copy of this object.
IlvHyperEdge	getHyperEdge() Returns the hyperedge of this end point.
IlvGraphic	getNode() Returns the end node that is connected to the hyperedge by this end point.
IlvPoint	getPosition(IlvTransformer t, boolean checkConnector) Returns the position of the hyperedge end in view coordinates.
boolean	isAbsolutePositioning() Returns true if absolute positioning is used, and false otherwise.
boolean	isDragging() Returns true if we are currently dragging the hyperedge end interactively.
void	positionChanged() Called when the position of this end might have changed.
void	setAbsolutePositioning(boolean absolute) Enables or disables absolute positioning.
void	setDragging(boolean dragging) Sets whether we are currently dragging the hyperedge end interactively.
void	setHyperEdge(IlvHyperEdge edge) Sets the hyperedge of this end point.
void	setPosition(IlvPoint p, IlvTransformer t) Sets the position of the hyperedge end.
void	write(IlvOutputStream stream) Writes the attributes of this object.
boolean	zoomable() Returns true if the end point of a hyperedge is zoomable.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultHyperEdgeEnd

protected IlvDefaultHyperEdgeEnd(IlvHyperEdge edge,
                                 IlvGraphic node)

Creates a new hyperedge end point at the input node.

Parameters:

edge - The hyperedge of the end point.

node - The end node that is connected to the hyperedge by this end point.

IlvDefaultHyperEdgeEnd

public IlvDefaultHyperEdgeEnd(IlvInputStream stream)
                       throws IlvReadFileException

Reads the object from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException - if the format is not correct.

Method Detail

copy

public IlvHyperEdgeEnd copy()

Creates a copy of this object.

Specified by:

copy in interface IlvHyperEdgeEnd

getHyperEdge

public IlvHyperEdge getHyperEdge()

Returns the hyperedge of this end point.

Specified by:

getHyperEdge in interface IlvHyperEdgeEnd

setHyperEdge

public void setHyperEdge(IlvHyperEdge edge)

Sets the hyperedge of this end point. You should not call this method. It is automatically called after reading from IlvInputStream.

Specified by:

setHyperEdge in interface IlvHyperEdgeEnd

See Also:

IlvPersistentObject

getNode

public IlvGraphic getNode()

Returns the end node that is connected to the hyperedge by this end point.

Specified by:

getNode in interface IlvHyperEdgeEnd

getPosition

public IlvPoint getPosition(IlvTransformer t,
                            boolean checkConnector)

Returns the position of the hyperedge end in view coordinates.

Specified by:

getPosition in interface IlvHyperEdgeEnd

Parameters:

t - The transformer to draw the hyperedge.

checkConnector - Whether the hyperedge connector is queried for the connection point.

setPosition

public void setPosition(IlvPoint p,
                        IlvTransformer t)

Sets the position of the hyperedge end. If the edge is inside a grapher, this must be done inside an applyToObject session of the edge (see IlvManager.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean)).

Specified by:

setPosition in interface IlvHyperEdgeEnd

Parameters:

p - The new position of the hyperedge in view coordinates.

t - The transformer to draw the hyperedge.

setDragging

public void setDragging(boolean dragging)

Sets whether we are currently dragging the hyperedge end interactively.

Specified by:

setDragging in interface IlvHyperEdgeEnd

isDragging

public boolean isDragging()

Returns true if we are currently dragging the hyperedge end interactively.

zoomable

public boolean zoomable()

Returns true if the end point of a hyperedge is zoomable. The end point of a hyperedge is zoomable if the following holds: t.apply(getPosition(null, true)) == getPosition(t, true)

Specified by:

zoomable in interface IlvHyperEdgeEnd

setAbsolutePositioning

public void setAbsolutePositioning(boolean absolute)

Enables or disables absolute positioning. If absolute positioning is enabled, the position of the hyperedge end point does not depend on the position of the end node. This means, if the end node is moved, the position of the hyperedge end does not change.

By default, relative positioning is used. This means the position of the hyperedge end point is always relative to the current position of the end node.

If the edge is inside a grapher, changing between absolute and relative positioning requires an applyToObject session of the corresponding edge (see IlvManager.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean)).

Parameters:

absolute - Whether absolute positioning is used.

See Also:

isAbsolutePositioning()

isAbsolutePositioning

public boolean isAbsolutePositioning()

Returns true if absolute positioning is used, and false otherwise.

See Also:

setAbsolutePositioning(boolean)

positionChanged

public void positionChanged()

Called when the position of this end might have changed. Reason can be that the end moved, or that the end position is relative to the node position and the node moved. This allows to clean coordinate caches.

Specified by:

positionChanged in interface IlvHyperEdgeEnd

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the attributes of this object.

Specified by:

write in interface IlvPersistentObject

Parameters:

stream - the output stream

Throws:

IOException - thrown when an exception occurs during the write operation for this object.