ilog.views

Class IlvConstantModeManagerFrame

java.lang.Object

ilog.views.IlvDefaultManagerFrame

ilog.views.IlvConstantModeManagerFrame

All Implemented Interfaces:

IlvManagerFrame, IlvResizableManagerFrame, IlvPersistentObject, IlvBaseTextDirectionInterface, Serializable

public class IlvConstantModeManagerFrame
extends IlvDefaultManagerFrame
implements IlvResizableManagerFrame

IlvConstantModeManagerFrame is an extended IlvDefaultManagerFrame that handles resize events automatically. IlvConstantModeManagerFrame keeps the sub manager zoom level constant by adjusting frame margins to meet the required size.

When a sub manager uses a IlvConstantModeManagerFrame, it has the following behavior:

• The margins are never negative.
• A minimum margin size can be set.
• The default margin size is 0.
• The sub manager can only be translated.
• The frame reacts to the IlvManager.moveResize(IlvRect) but not IlvManager.applyTransform(IlvTransformer). Call IlvManager.applyTransform(IlvTransformer) to apply a specific transformation only.
• When dragging a handle the following actions occur: while reshaping the sub manager, the margin next to the handle is adjusted first. If this margin is reduced to zero, the margin on the other side of the frame is adjusted.
• IlvConstantModeManagerFrame objects cannot have negative margins, when both left and right margins become zero, the sub manager stops the reshape operation.
• IlvConstantModeManagerFrame objects listens to sub manager or grapher content changes. When the bounding box of the sub manager grows, in order to keep the global bounding box constant the frame tries to reduce the margins first.
• You should not share the same IlvConstantModeManagerFrame among different managers, but allocate a new frame for each manager. If you share the frame, resizing the manager frame interactively will not work.

Since:

JViews 7.5

See Also:

Serialized Form

Field Summary

Fields inherited from class ilog.views.IlvDefaultManagerFrame

BOTTOM, CENTER, LEFT, RIGHT, TOP, WRAPPED

Constructor Summary

Constructors

Constructor and Description
IlvConstantModeManagerFrame() Creates a IlvConstantModeManagerFrame instance.
IlvConstantModeManagerFrame(double minimumMargin) Creates a Creates a IlvConstantModeManagerFrame instance.constant mode manager frame with a minimum margin.
IlvConstantModeManagerFrame(IlvConstantModeManagerFrame source) Creates an IlvConstantModeManagerFrame by copying the specified one.
IlvConstantModeManagerFrame(IlvInputStream stream) Reads an IlvConstantModeManagerFrame from an IlvInputStream.

Method Summary

Modifier and Type	Method and Description
IlvManagerFrame	copy() Creates an IlvConstantModeManagerFrame by copying itself.
double	getMinimumMargin() Gets the minimum margin allowed.
void	managerChanged(IlvManager manager) This function adjusts the margins after its manager has been changed.
boolean	moveResize(IlvManager manager, IlvRect size) Adjusts the margins to meet the specified size.
void	setBottomMargin(double margin) Sets the bottom margin.
void	setLeftMargin(double margin) Sets the left margin.
void	setMinimumMargin(double minimumMargin) Set the minimum margin allowed.
void	setRightMargin(double margin) Sets the right margin.
void	setTopMargin(double margin) Sets the top margin.
void	write(IlvOutputStream stream) Writes the frame to an IlvOutputStream.

Methods inherited from class ilog.views.IlvDefaultManagerFrame

baseTextDirectionChanged, boundingBoxExpandCollapseIcon, checkZoomFactor, componentOrientationChanged, contains, draw, drawBackground, drawExpandCollapseIcon, drawOutline, drawShadow, drawTitleBackground, drawTitleText, getAbsoluteExpandCollapseIconPosition, getBackground, getBaseTextDirection, getBottomMargin, getBottomMargin, getExpandCollapseIcon, getExpandCollapseIconPosition, getFont, getForeground, getLeftMargin, getLeftMargin, getMaxTitleZoomFactor, getMinTitleZoomFactor, getOpaque, getRelativeExpandCollapseIconPosition, getResolvedBaseTextDirection, getResolvedBaseTextDirection, getRightMargin, getRightMargin, getShadowPaint, getShadowPosition, getShadowThickness, getTitle, getTitle, getTitleColor, getTitleHeight, getTitleJustification, getTopMargin, getTopMargin, isOpaque, isShowingExpandCollapseIcon, isShowingTitle, localeChanged, setAbsoluteExpandCollapseIconPosition, setBackground, setBaseTextDirection, setBaseTextDirection, setExpandCollapseIcon, setExpandCollapseIconPosition, setFont, setForeground, setMaxTitleZoomFactor, setMinTitleZoomFactor, setOpaque, setRelativeExpandCollapseIconPosition, setShadowPaint, setShadowPosition, setShadowThickness, setShowingExpandCollapseIcon, setShowingTitle, setTitle, setTitleColor, setTitleJustification

Methods inherited from class java.lang.Object

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

Methods inherited from interface ilog.views.IlvManagerFrame

contains, draw, getBottomMargin, getLeftMargin, getRightMargin, getTopMargin, isOpaque

Constructor Detail

IlvConstantModeManagerFrame

public IlvConstantModeManagerFrame()

Creates a IlvConstantModeManagerFrame instance.

IlvConstantModeManagerFrame

public IlvConstantModeManagerFrame(double minimumMargin)

Creates a Creates a IlvConstantModeManagerFrame instance.constant mode manager frame with a minimum margin.

Parameters:

minimumMargin - The minimum margin allowed, must not be negative.

IlvConstantModeManagerFrame

public IlvConstantModeManagerFrame(IlvConstantModeManagerFrame source)

Creates an IlvConstantModeManagerFrame by copying the specified one.

Parameters:

source - The IlvConstantModeManagerFrame object to copy.

See Also:

copy()

IlvConstantModeManagerFrame

public IlvConstantModeManagerFrame(IlvInputStream stream)
                            throws IOException,
                                   IlvReadFileException

Reads an IlvConstantModeManagerFrame from an IlvInputStream.

Parameters:

stream - The input stream to read from.

Throws:

IOException

IlvReadFileException

Method Detail

copy

public IlvManagerFrame copy()

Creates an IlvConstantModeManagerFrame by copying itself.

Specified by:

copy in interface IlvManagerFrame

Overrides:

copy in class IlvDefaultManagerFrame

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the frame to an IlvOutputStream.

Specified by:

write in interface IlvPersistentObject

Overrides:

write in class IlvDefaultManagerFrame

Parameters:

stream - The output stream.

Throws:

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

getMinimumMargin

public double getMinimumMargin()

Gets the minimum margin allowed.

Returns:

The minimum margin allowed.

setTopMargin

public void setTopMargin(double margin)

Sets the top margin. This method does not take into account the title.

Overrides:

setTopMargin in class IlvDefaultManagerFrame

Parameters:

margin - Must be greater than or equal to the minimum margin. If not, the minimum margin is set.

setBottomMargin

public void setBottomMargin(double margin)

Sets the bottom margin.

Overrides:

setBottomMargin in class IlvDefaultManagerFrame

Parameters:

margin - Must be greater than or equal to the minimum margin. If not, the minimum margin is set.

setLeftMargin

public void setLeftMargin(double margin)

Sets the left margin.

Overrides:

setLeftMargin in class IlvDefaultManagerFrame

Parameters:

margin - Must be greater than or equal to the minimum margin. If not, the minimum margin is set.

setRightMargin

public void setRightMargin(double margin)

Sets the right margin.

Overrides:

setRightMargin in class IlvDefaultManagerFrame

Parameters:

margin - Must be greater than or equal to the minimum margin. If not, the minimum margin is set.

setMinimumMargin

public void setMinimumMargin(double minimumMargin)

Set the minimum margin allowed. This function might adjust the margins so that they are all greater than or equal to the minimum margin.

Parameters:

minimumMargin - The minimum margin allowed, must not be negative.

moveResize

public boolean moveResize(IlvManager manager,
                          IlvRect size)

Adjusts the margins to meet the specified size. This method is called when the moveResize() of a submanager is called.

Specified by:

moveResize in interface IlvResizableManagerFrame

Overrides:

moveResize in class IlvDefaultManagerFrame

Parameters:

manager - The manager to be transformed. This object must have a IlvResizableManagerFrame manager frame.

size - The new size to be applied to the submanager.

Returns:

true, to indicate the frame is capable of resizing the inner manager.

managerChanged

public void managerChanged(IlvManager manager)

This function adjusts the margins after its manager has been changed. It is typically called by the applyTransform() method of the inner manager. When the bounding box of the inner manager grows, the frame tries to reduce the margins first in order to keep the global bounding box constant.

Specified by:

managerChanged in interface IlvResizableManagerFrame

Overrides:

managerChanged in class IlvDefaultManagerFrame

Parameters:

manager - The inner manager that has been changed.