ilog.views.sdm.renderer

Class IlvSubGraphRenderer.GraphicManagerFrame

java.lang.Object

ilog.views.sdm.renderer.IlvSubGraphRenderer.GraphicManagerFrame

All Implemented Interfaces:

IlvGraphicBag, IlvManagerFrame, IlvResizableManagerFrame, ilog.views.internal.IlvGraphicManagerFrame, IlvPersistentObject, IlvComponentOrientationAware, IlvULocaleAware, IlvBaseTextDirectionInterface, Serializable

Enclosing class:

IlvSubGraphRenderer

public static class IlvSubGraphRenderer.GraphicManagerFrame
extends Object
implements ilog.views.internal.IlvGraphicManagerFrame, IlvResizableManagerFrame, IlvPersistentObject, IlvGraphicBag, IlvULocaleAware, IlvComponentOrientationAware, IlvBaseTextDirectionInterface

This class draws the graphic border of IlvGrapher objects that represent subgraphs. The graphic border takes a graphic object (usually an IlvExpandedFrame) and draws it around the manager.

This class is public only to allow saving in an IVL file the contents of a grapher associated with an SDM engine and containing expandable nodes.

Since:

JViews 5.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GraphicManagerFrame(IlvInputStream stream) Reads the border from an IVL stream.

Method Summary

Modifier and Type	Method and Description
void	addObject(IlvGraphic graphic, boolean redraw) Adds a graphic object in the bag.
void	applyToObject(IlvGraphic graphic, IlvApplyObject f, Object arg, boolean redraw) Applies a method to a graphic object of the bag.
boolean	contains(IlvManager manager, IlvPoint p, IlvPoint tp, IlvTransformer t) Tests if a point lies within the outline of the border.
IlvManagerFrame	copy() Creates a new border by copying this one.
void	draw(IlvManager manager, IlvRect bbox, Graphics g, IlvTransformer t) Draws the border.
int	getBaseTextDirection() Returns the base direction of the text.
double	getBottomMargin(IlvManager manager, IlvTransformer t) Returns the margin on the bottom of the specified manager.
ComponentOrientation	getComponentOrientation() Returns the component orientation of this object.
IlvGraphic	getFrameGraphic() Returns the graphic object drawn by the frame.
IlvGraphicBag	getGraphicBag() Returns the parent grapher.
double	getLeftMargin(IlvManager manager, IlvTransformer t) Returns the margin on the left of the specified manager.
IlvGraphic	getObject(String name) Returns the graphic object with that name if it exists in the bag, otherwise returns null.
IlvGraphicEnumeration	getObjects() Implementation of the IlvGraphicBag interface.
int	getResolvedBaseTextDirection() Returns the resolved base text direction.
double	getRightMargin(IlvManager manager, IlvTransformer t) Returns the margin on the right of the specified manager.
double	getTopMargin(IlvManager manager, IlvTransformer t) Returns the margin on top of the specified manager.
com.ibm.icu.util.ULocale	getULocale() Returns the locale of this object.
boolean	isOpaque(IlvManager manager) Returns true.
void	managerChanged(IlvManager manager) The implementation of this method must react to the change of the inner manager.
void	moveObject(IlvGraphic graphic, double x, double y, boolean redraw) Changes the location of a graphic object.
boolean	moveResize(IlvManager manager, IlvRect size) This method handles the submanager resize event.
void	reDrawObj(IlvGraphic graphic) Redraws a graphic object located in the bag.
void	reDrawRegion(IlvRegion region) Redraws a region of the bag.
void	removeObject(IlvGraphic graphic, boolean redraw) Removes a graphic object from the bag.
void	reshapeObject(IlvGraphic graphic, IlvRect newrect, boolean redraw) Changes the size of a graphic object.
void	resizeGraphic(IlvTransformer t, IlvRect bbox) Resizes the graphic objects drawn by the frame according to the bounding box of the manager.
void	setBaseTextDirection(int baseTextDirection) Sets the base direction of the text.
void	setComponentOrientation(ComponentOrientation orientation) Sets the component orientation of this object.
boolean	setObjectName(IlvGraphic graphic, String name) Changes the name of a graphic object.
void	setULocale(com.ibm.icu.util.ULocale locale) Sets the locale of this object.
void	write(IlvOutputStream stream) Writes the border to an IVL stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphicManagerFrame

public GraphicManagerFrame(IlvInputStream stream)
                    throws IlvReadFileException,
                           IOException

Reads the border from an IVL stream.

Parameters:

stream - The input stream.

Throws:

IlvReadFileException

IOException

Method Detail

write

public void write(IlvOutputStream stream)
           throws IOException

Writes the border to an IVL stream.

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.

getFrameGraphic

public IlvGraphic getFrameGraphic()

Returns the graphic object drawn by the frame.

Specified by:

getFrameGraphic in interface ilog.views.internal.IlvGraphicManagerFrame

Since:

JViews 6.0

copy

public IlvManagerFrame copy()

Creates a new border by copying this one.

Specified by:

copy in interface IlvManagerFrame

getTopMargin

public double getTopMargin(IlvManager manager,
                           IlvTransformer t)

Returns the margin on top of the specified manager.

Specified by:

getTopMargin in interface IlvManagerFrame

Parameters:

manager - The manager.

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

getBottomMargin

public double getBottomMargin(IlvManager manager,
                              IlvTransformer t)

Returns the margin on the bottom of the specified manager.

Specified by:

getBottomMargin in interface IlvManagerFrame

Parameters:

manager - The manager.

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

getRightMargin

public double getRightMargin(IlvManager manager,
                             IlvTransformer t)

Returns the margin on the right of the specified manager.

Specified by:

getRightMargin in interface IlvManagerFrame

Parameters:

manager - The manager.

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

getLeftMargin

public double getLeftMargin(IlvManager manager,
                            IlvTransformer t)

Returns the margin on the left of the specified manager.

Specified by:

getLeftMargin in interface IlvManagerFrame

Parameters:

manager - The manager.

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

isOpaque

public boolean isOpaque(IlvManager manager)

Returns true.

Specified by:

isOpaque in interface IlvManagerFrame

Parameters:

manager - The manager.

draw

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

Draws the border.

Specified by:

draw in interface IlvManagerFrame

Parameters:

manager - The manager.

bbox - The bounding box of the manager.

g - The Graphics used to draw the border.

t - The transformer used to draw the border.

resizeGraphic

public void resizeGraphic(IlvTransformer t,
                          IlvRect bbox)

Resizes the graphic objects drawn by the frame according to the bounding box of the manager.

This method is normally called by the draw(ilog.views.IlvManager, ilog.views.IlvRect, java.awt.Graphics, ilog.views.IlvTransformer) method, it can be called directly to ensure that the frame graphic has the correct size before it is drawn.

Specified by:

resizeGraphic in interface ilog.views.internal.IlvGraphicManagerFrame

Parameters:

t - The current transformer.

bbox - The bounding box of the manager.

Since:

JViews 6.0

contains

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

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

Specified by:

contains in interface IlvManagerFrame

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 border.

moveResize

public boolean moveResize(IlvManager manager,
                          IlvRect size)

This method handles the submanager resize event. It is called when the moveResize() method of a submanager is called.

The implementation of this method should handle the reshape of the submanager, typically by adjusting the margins as necessary.

Specified by:

moveResize in interface IlvResizableManagerFrame

Parameters:

manager - The submanager to be transformed.

size - The new size of the submanager.

Returns:

true if the frame handles the inner manager's resizing. Otherwise, the frame does not handle the resizing.

Since:

JViews 8.7

managerChanged

public void managerChanged(IlvManager manager)

The implementation of this method must react to the change of the inner manager. It is typically called by the applyTransform() method of the inner manager.

Specified by:

managerChanged in interface IlvResizableManagerFrame

Parameters:

manager - The inner manager that has been changed.

Since:

JViews 8.7

setULocale

public void setULocale(com.ibm.icu.util.ULocale locale)

Sets the locale of this object. Don't set null.

Specified by:

setULocale in interface IlvULocaleAware

Parameters:

locale - The new locale.

Since:

JViews 8.8

See Also:

getULocale()

getULocale

public com.ibm.icu.util.ULocale getULocale()

Returns the locale of this object. It should never return null.

Specified by:

getULocale in interface IlvULocaleAware

Since:

JViews 8.8

See Also:

setULocale(com.ibm.icu.util.ULocale)

setComponentOrientation

public void setComponentOrientation(ComponentOrientation orientation)

Sets the component orientation of this object. Don't set null.

Specified by:

setComponentOrientation in interface IlvComponentOrientationAware

Parameters:

orientation - The new component orientation.

Since:

JViews 8.8

See Also:

getComponentOrientation()

getComponentOrientation

public ComponentOrientation getComponentOrientation()

Returns the component orientation of this object. It should never return null.

Specified by:

getComponentOrientation in interface IlvComponentOrientationAware

Since:

JViews 8.8

See Also:

setComponentOrientation(java.awt.ComponentOrientation)

setBaseTextDirection

public void setBaseTextDirection(int baseTextDirection)

Sets the base direction of the text. Set only the values allowed for the resolved base text direction.

Specified by:

setBaseTextDirection in interface IlvBaseTextDirectionInterface

Parameters:

baseTextDirection - The base text direction.

Since:

JViews 8.8

getBaseTextDirection

public int getBaseTextDirection()

Returns the base direction of the text.

Specified by:

getBaseTextDirection in interface IlvBaseTextDirectionInterface

Returns:

The base text direction.

Since:

JViews 8.8

getResolvedBaseTextDirection

public int getResolvedBaseTextDirection()

Returns the resolved base text direction.

Specified by:

getResolvedBaseTextDirection in interface IlvBaseTextDirectionInterface

Returns:

The resolved base text direction.

Since:

JViews 8.8

addObject

public void addObject(IlvGraphic graphic,
                      boolean redraw)

Adds a graphic object in the bag.

Specified by:

addObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

redraw - If true the object is redrawn.

Since:

JViews 5.5

removeObject

public void removeObject(IlvGraphic graphic,
                         boolean redraw)

Removes a graphic object from the bag.

Specified by:

removeObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

redraw - If true the object is redrawn.

Since:

JViews 5.5

getObjects

public IlvGraphicEnumeration getObjects()

Implementation of the IlvGraphicBag interface. Do not call this method directly.

Specified by:

getObjects in interface IlvGraphicBag

Returns:

An enumeration of IlvGraphic objects, or null.

Since:

JViews 5.5

reDrawObj

public void reDrawObj(IlvGraphic graphic)

Redraws a graphic object located in the bag.

Specified by:

reDrawObj in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

Since:

JViews 5.5

reDrawRegion

public void reDrawRegion(IlvRegion region)

Redraws a region of the bag.

Specified by:

reDrawRegion in interface IlvGraphicBag

Parameters:

region - The region to redraw.

Since:

JViews 5.5

reshapeObject

public void reshapeObject(IlvGraphic graphic,
                          IlvRect newrect,
                          boolean redraw)

Changes the size of a graphic object.

Specified by:

reshapeObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

newrect - The new desired bounding rectangle.

redraw - If true the object is redrawn.

Since:

JViews 5.5

moveObject

public void moveObject(IlvGraphic graphic,
                       double x,
                       double y,
                       boolean redraw)

Changes the location of a graphic object.

Specified by:

moveObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

x - The new desired x position.

y - The new desired y position.

redraw - If true the object is redrawn.

Since:

JViews 5.5

applyToObject

public void applyToObject(IlvGraphic graphic,
                          IlvApplyObject f,
                          Object arg,
                          boolean redraw)

Applies a method to a graphic object of the bag.

Specified by:

applyToObject in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

f - The method to apply.

arg - The arguments passed to the method f.

redraw - If true the object is redrawn.

Since:

JViews 5.5

setObjectName

public boolean setObjectName(IlvGraphic graphic,
                             String name)

Changes the name of a graphic object.

Specified by:

setObjectName in interface IlvGraphicBag

Parameters:

graphic - The graphic object.

name - The new name.

Returns:

true if the name can be changed.

Since:

JViews 5.5

getObject

public IlvGraphic getObject(String name)

Returns the graphic object with that name if it exists in the bag, otherwise returns null.

Specified by:

getObject in interface IlvGraphicBag

Parameters:

name - The graphic object name.

Since:

JViews 6.0

getGraphicBag

public IlvGraphicBag getGraphicBag()

Returns the parent grapher.

Specified by:

getGraphicBag in interface IlvGraphicBag