ilog.views.graphic.linkbundle

Interface IlvLinkBundleFrame

All Known Implementing Classes:

IlvDefaultLinkBundleFrame

public interface IlvLinkBundleFrame

The frame of an IlvLinkBundle. The IlvLinkBundleFrame interface defines the frame that is drawn around an IlvLinkBundle when this link bundle is added into another link bundle or into a grapher. This interface defines the margin that will be added around the link bundle. It defines how the frame is drawn (for example, an implementing class can draw a background underneath the content of the link bundle) and how hit testing on the frame is performed.

Since:

JViews 8.0

Method Summary

Modifier and Type	Method and Description
IlvRect	boundingBox(IlvLinkBundle linkBundle, IlvTransformer t) 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 t) Tests if a point lies within the outline of the frame.
IlvLinkBundleFrame	copy() Creates a new frame by copying this one.
void	draw(IlvLinkBundle linkBundle, Graphics g, IlvTransformer t) Draws the frame.
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 selected frame.
double	getMargin(IlvLinkBundle linkBundle, IlvTransformer t) Returns the margin of the specified link bundle.

Method Detail

copy

IlvLinkBundleFrame copy()

Creates a new frame by copying this one.

boundingBox

IlvRect boundingBox(IlvLinkBundle linkBundle,
                    IlvTransformer t)

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

Parameters:

linkBundle - The link bundle.

t - The transformer used to draw the link bundle.

getMargin

double getMargin(IlvLinkBundle linkBundle,
                 IlvTransformer t)

Returns the margin of the specified link bundle.

Parameters:

linkBundle - The link bundle.

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

draw

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

Draws the frame. This is called when the frame is not selected.

Parameters:

linkBundle - The link bundle.

g - The Graphics used to draw the frame.

t - The transformer used to draw the frame.

drawSelected

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

Draws the selected frame. This is called when drawing an IlvLinkBundleSelection.

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

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

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

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

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.

Parameters:

linkBundle - The link bundle.

t - The transformer used to draw the frame.

Since:

JViews 8.8

contains

boolean contains(IlvLinkBundle linkBundle,
                 IlvPoint p,
                 IlvPoint tp,
                 IlvTransformer t)

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

Parameters:

linkBundle - The link bundle.

p - The point to be tested.

tp - The point p transformed by the transformer t.

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