ilog.views.graphic.linkbundle

Class IlvDefaultLinkBundleFrame

java.lang.Object

ilog.views.graphic.linkbundle.IlvDefaultLinkBundleFrame

All Implemented Interfaces:

IlvLinkBundleFrame, IlvPersistentObject, Serializable

public class IlvDefaultLinkBundleFrame
extends Object
implements IlvLinkBundleFrame, Serializable, IlvPersistentObject

The default frame for an IlvLinkBundle. The IlvDefaultLinkBundleFrame class defines the default frame that is drawn around an IlvLinkBundle when this link bundle is added into another link bundle or into a grapher.

Since:

JViews 8.0

See Also:

IlvLinkBundle.setFrame(ilog.views.graphic.linkbundle.IlvLinkBundleFrame), setBackground(java.awt.Paint), setMargin(double), Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvDefaultLinkBundleFrame() Creates a default link bundle frame.
IlvDefaultLinkBundleFrame(IlvDefaultLinkBundleFrame source) Creates an IlvDefaultLinkBundleFrame by copying the specified one.
IlvDefaultLinkBundleFrame(IlvInputStream stream) Reads an IlvDefaultLinkBundleFrame from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
IlvRect	boundingBox(IlvLinkBundle linkBundle, IlvTransformer transformer) Returns the bounding rectangle of the frame for a given link bundle and transformer.
IlvRect	boundingBoxExpandCollapseIcon(IlvLinkBundle linkBundle, IlvTransformer t) Returns the bounding box of the expand/collapse icon for a given link bundle.
boolean	contains(IlvLinkBundle linkBundle, IlvPoint p, IlvPoint tp, IlvTransformer transformer) Tests if a point lies within the outline of the frame.
IlvLinkBundleFrame	copy() Creates an IlvDefaultLinkBundleFrame by copying this one.
void	draw(IlvLinkBundle linkBundle, Graphics g, IlvTransformer t) Draws the frame for a given link bundle.
void	drawExpandCollapseIcon(IlvLinkBundle linkBundle, Graphics g, IlvTransformer t) Draws the expand/collapse icon for a given link bundle.
void	drawSelected(IlvLinkBundle linkBundle, Graphics g, IlvTransformer t, IlvLinkBundleSelection sel) Draws the frame for a given link bundle.
IlvPoint	getAbsoluteExpandCollapseIconPosition() Returns the absolute position of the icon that represents the expand or collapse state of the frame.
Paint	getBackground() Returns the Paint object used to draw the background of the link bundle when it is not selected.
IlvGraphic	getExpandCollapseIcon() Returns the icon that represents the expand or collapse state of the frame.
protected IlvPoint	getExpandCollapseIconPosition(IlvLinkBundle linkBundle, IlvTransformer t) Calculates the position of the expand/collapse icon at the link bundle.
double	getMargin() Returns the margin.
double	getMargin(IlvLinkBundle linkBundle, IlvTransformer t) Returns the margin of the specified link bundle.
IlvPoint	getRelativeExpandCollapseIconPosition() Returns the relative position of the icon that represents the expand or collapse state of the frame.
boolean	isShowingExpandCollapseIcon() Returns whether the icon that represents the expand or collapse state of the frame is shown.
void	setAbsoluteExpandCollapseIconPosition(IlvPoint p) Sets the absolute position of the icon that represents the expand or collapse state of the frame.
void	setBackground(Paint p) Changes the Paint object used to draw the background of the link bundle.
void	setExpandCollapseIcon(IlvGraphic g) Sets the icon that represents the expand or collapse state of the frame.
void	setExpandCollapseIconPosition(double parallelRelative, double perpendicularRelative, double parallelAbsolute, double perpendicularAbsolute) Sets the position of the icon that represents the expand or collapse state of the frame.
void	setMargin(double margin) Sets the margin.
void	setRelativeExpandCollapseIconPosition(IlvPoint p) Sets the relative position of the icon that represents the expand or collapse state of the frame.
void	setShowingExpandCollapseIcon(boolean show) Sets whether the icon that represents the expand or collapse state of the frame is shown.
void	write(IlvOutputStream stream) Writes the frame to an IlvOutputStream.

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDefaultLinkBundleFrame

public IlvDefaultLinkBundleFrame()

Creates a default link bundle frame.

IlvDefaultLinkBundleFrame

public IlvDefaultLinkBundleFrame(IlvDefaultLinkBundleFrame source)

Creates an IlvDefaultLinkBundleFrame by copying the specified one.

Parameters:

source - The origin of the copy.

See Also:

copy()

IlvDefaultLinkBundleFrame

public IlvDefaultLinkBundleFrame(IlvInputStream stream)
                          throws IOException,
                                 IlvReadFileException

Reads an IlvDefaultLinkBundleFrame from an IlvInputStream.

Parameters:

stream - The input stream.

Throws:

IOException

IlvReadFileException

Method Detail

copy

public IlvLinkBundleFrame copy()

Creates an IlvDefaultLinkBundleFrame by copying this one.

Specified by:

copy in interface IlvLinkBundleFrame

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the frame to an IlvOutputStream.

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.

getMargin

public double getMargin(IlvLinkBundle linkBundle,
                        IlvTransformer t)

Returns the margin of the specified link bundle.

Specified by:

getMargin in interface IlvLinkBundleFrame

Parameters:

linkBundle - The link bundle.

t - The transformer used to draw the link bundle and the frame.

boundingBox

public IlvRect boundingBox(IlvLinkBundle linkBundle,
                           IlvTransformer transformer)

Returns the bounding rectangle of the frame for a given link bundle and transformer.

Specified by:

boundingBox in interface IlvLinkBundleFrame

Parameters:

linkBundle - The link bundle.

transformer - The transformer used to draw the link bundle.

getMargin

public double getMargin()

Returns the margin.

setMargin

public void setMargin(double margin)

Sets the margin.

getBackground

public Paint getBackground()

Returns the Paint object used to draw the background of the link bundle when it is not selected.

See Also:

setBackground(java.awt.Paint)

setBackground

public void setBackground(Paint p)

Changes the Paint object used to draw the background of the link bundle.

See Also:

getBackground()

setExpandCollapseIcon

public void setExpandCollapseIcon(IlvGraphic g)

Sets the icon that represents the expand or collapse state of the frame.

Since:

JViews 8.8

getExpandCollapseIcon

public IlvGraphic getExpandCollapseIcon()

Returns the icon that represents the expand or collapse state of the frame.

Since:

JViews 8.8

isShowingExpandCollapseIcon

public boolean isShowingExpandCollapseIcon()

Returns whether the icon that represents the expand or collapse state of the frame is shown.

Since:

JViews 8.8

setShowingExpandCollapseIcon

public void setShowingExpandCollapseIcon(boolean show)

Sets whether the icon that represents the expand or collapse state of the frame is shown. It calls setExpandCollapseIcon(ilog.views.IlvGraphic) to install or deinstall the icon.

Since:

JViews 8.8

setExpandCollapseIconPosition

public void setExpandCollapseIconPosition(double parallelRelative,
                                          double perpendicularRelative,
                                          double parallelAbsolute,
                                          double perpendicularAbsolute)

Sets the position of the icon that represents the expand or collapse state of the frame. The position is the sum of the absolute position and the relative position. It denotes the center point of the icon. The absolute and relative position consists in two components: one parallel to the link flow, and one perpendicular to the link flow. The relative position 0 parallel to the link flow denotes the start of the link, 1 the end of the link, and 0.5 the middle of the link. The relative position 0.5 denotes the middle of the link, and 1 and 0 the margins of the link frame. The absolute positions are added as manager coordinates.

Parameters:

parallelRelative - The relative position parallel to the link flow.

perpendicularRelative - The relative position perpendicular to the link flow.

parallelAbsolute - The absolute position parallel to the link flow.

perpendicularAbsolute - The absolute position perpendicular to the link flow.

Since:

JViews 8.8

getRelativeExpandCollapseIconPosition

public final IlvPoint getRelativeExpandCollapseIconPosition()

Returns the relative position of the icon that represents the expand or collapse state of the frame. The x element of the point is the component parallel to the link flow. The y element of the point is the component perpendicular to the link flow.

Since:

JViews 8.8

See Also:

setExpandCollapseIconPosition(double, double, double, double)

setRelativeExpandCollapseIconPosition

public void setRelativeExpandCollapseIconPosition(IlvPoint p)

Sets the relative position of the icon that represents the expand or collapse state of the frame. The x element of the point is the component parallel to the link flow. The y element of the point is the component perpendicular to the link flow.

Since:

JViews 8.8

See Also:

setExpandCollapseIconPosition(double, double, double, double)

getAbsoluteExpandCollapseIconPosition

public final IlvPoint getAbsoluteExpandCollapseIconPosition()

Returns the absolute position of the icon that represents the expand or collapse state of the frame. The x element of the point is the component parallel to the link flow. The y element of the point is the component perpendicular to the link flow.

Since:

JViews 8.8

See Also:

setExpandCollapseIconPosition(double, double, double, double)

setAbsoluteExpandCollapseIconPosition

public void setAbsoluteExpandCollapseIconPosition(IlvPoint p)

Sets the absolute position of the icon that represents the expand or collapse state of the frame. The x element of the point is the component parallel to the link flow. The y element of the point is the component perpendicular to the link flow.

Since:

JViews 8.8

See Also:

setExpandCollapseIconPosition(double, double, double, double)

draw

public void draw(IlvLinkBundle linkBundle,
                 Graphics g,
                 IlvTransformer t)

Draws the frame for a given link bundle. This is called when the frame is not selected.

Specified by:

draw in interface IlvLinkBundleFrame

Parameters:

linkBundle - The link bundle.

g - The Graphics used to draw the frame.

t - The transformer used to draw the frame.

drawSelected

public void drawSelected(IlvLinkBundle linkBundle,
                         Graphics g,
                         IlvTransformer t,
                         IlvLinkBundleSelection sel)

Draws the frame for a given link bundle. This is called when drawing an IlvLinkBundleSelection.

Specified by:

drawSelected in interface IlvLinkBundleFrame

Parameters:

linkBundle - The link bundle.

g - The Graphics used to draw the frame.

t - The transformer used to draw the frame.

sel - The selection object of the link bundle.

Since:

JViews 8.8

drawExpandCollapseIcon

public void drawExpandCollapseIcon(IlvLinkBundle linkBundle,
                                   Graphics g,
                                   IlvTransformer t)

Draws the expand/collapse icon for a given link bundle.

Specified by:

drawExpandCollapseIcon in interface IlvLinkBundleFrame

Parameters:

linkBundle - The link bundle.

g - The Graphics used to draw the frame.

t - The transformer used to draw the frame.

Since:

JViews 8.8

boundingBoxExpandCollapseIcon

public IlvRect boundingBoxExpandCollapseIcon(IlvLinkBundle linkBundle,
                                             IlvTransformer t)

Returns the bounding box of the expand/collapse icon for a given link bundle. Returns null if there is not expand/collapse icon.

Specified by:

boundingBoxExpandCollapseIcon in interface IlvLinkBundleFrame

Parameters:

linkBundle - The link bundle.

t - The transformer used to draw the frame.

Since:

JViews 8.8

getExpandCollapseIconPosition

protected IlvPoint getExpandCollapseIconPosition(IlvLinkBundle linkBundle,
                                                 IlvTransformer t)

Calculates the position of the expand/collapse icon at the link bundle.

Parameters:

linkBundle - The link bundle.

t - The transformer used to draw the frame.

Since:

JViews 8.8

contains

public boolean contains(IlvLinkBundle linkBundle,
                        IlvPoint p,
                        IlvPoint tp,
                        IlvTransformer transformer)

Tests if a point lies within the outline of the frame.

Specified by:

contains in interface IlvLinkBundleFrame

Parameters:

linkBundle - The link bundle.

p - The point to be tested.

tp - The point p transformed by the transformer t.

transformer - The transformation that is used to draw the frame.