ilog.views
Interface IlvManagerFrame

All Known Subinterfaces:

IlvResizableManagerFrame

All Known Implementing Classes:

IlvConstantModeManagerFrame, IlvDefaultGraphicManagerFrame, IlvDefaultManagerFrame, IlvSubGraphRenderer.GraphicManagerFrame

public interface IlvManagerFrame

The frame of an IlvManager. The IlvManagerFrame interface defines the frame that is drawn around an IlvManager when this manager is added into another manager. This interface defines the margin that will be added around the manager. It defines how the frame is drawn (for example, an implementing class can draw a background underneath the content of the manager as well as a frame around it) and how hit testing on the frame is performed.

This interface defines the base functionality of a manager frame. IlvResizableManagerFrame defines an extension of manager frame that reacts to the inner manager's changes and adjusts them.

Since:

JViews 5.0

See Also:

IlvResizableManagerFrame

Method Summary

boolean	contains(IlvManager manager, IlvPoint p, IlvPoint tp, IlvTransformer t) Tests if a point lies within the outline of the frame.
IlvManagerFrame	copy() Creates a new frame by copying this one.
void	draw(IlvManager manager, IlvRect bbox, Graphics g, IlvTransformer t) Draws the frame.
float	getBottomMargin(IlvManager manager, IlvTransformer t) Returns the margin on the bottom of the specified manager.
float	getLeftMargin(IlvManager manager, IlvTransformer t) Returns the margin on the left side of the specified manager.
float	getRightMargin(IlvManager manager, IlvTransformer t) Returns the margin on the right side of the specified manager.
float	getTopMargin(IlvManager manager, IlvTransformer t) Returns the margin on top of the specified manager.
boolean	isOpaque(IlvManager manager) Returns true if the frame is opaque, meaning that the frame is filling the background of the manager.

Method Detail

copy

IlvManagerFrame copy()

Creates a new frame by copying this one.

getTopMargin

float getTopMargin(IlvManager manager,
                   IlvTransformer t)

Returns the margin on top of the specified manager.

Parameters:

manager - The manager.

t - The transformer used to draw the manager and the frame.

getBottomMargin

float getBottomMargin(IlvManager manager,
                      IlvTransformer t)

Returns the margin on the bottom of the specified manager.

Parameters:

manager - The manager.

t - The transformer used to draw the manager and the frame.

getRightMargin

float getRightMargin(IlvManager manager,
                     IlvTransformer t)

Returns the margin on the right side of the specified manager.

Parameters:

manager - The manager.

t - The transformer used to draw the manager and the frame.

getLeftMargin

float getLeftMargin(IlvManager manager,
                    IlvTransformer t)

Returns the margin on the left side of the specified manager.

Parameters:

manager - The manager.

t - The transformer used to draw the manager and the frame.

isOpaque

boolean isOpaque(IlvManager manager)

Returns true if the frame is opaque, meaning that the frame is filling the background of the manager.

Parameters:

manager - The manager.

draw

void draw(IlvManager manager,
          IlvRect bbox,
          Graphics g,
          IlvTransformer t)

Draws the frame.

Parameters:

manager - The manager.

bbox - The bounding box of the manager in the view coordinate system.

g - The Graphics used to draw the frame.

t - The transformer used to draw the frame.

contains

boolean contains(IlvManager manager,
                 IlvPoint p,
                 IlvPoint tp,
                 IlvTransformer t)

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

Parameters:

manager - The manager.

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.