ilog.views.graphic.composite.decoration
Class IlvRectBalloon

java.lang.Object
  extended by ilog.views.IlvGraphic
      extended by ilog.views.graphic.composite.decoration.IlvBalloon
          extended by ilog.views.graphic.composite.decoration.IlvRectBalloon
All Implemented Interfaces:
IlvHotSpot, IlvPersistentObject, Transferable, Serializable

public class IlvRectBalloon
extends IlvBalloon

IlvRectBalloon represents an balloon with a rectangle shape.

The default settings for an IlvRectBalloon instance are the same as IlvBalloon.

Example

The following code example shows how to use IlvRectBalloon in a simple Java application:
  IlvManager manager = new IlvManager();
  // Creates the composite graphic with an IlvCenteredLayout
  IlvCompositeGraphic node = new IlvCompositeGraphic();
  node.setLayout(new IlvCenteredLayout(new Insets(4,10,4,10)));

  // Creates the balloon
  IlvRectBalloon balloon = new IlvRectBalloon();
  balloon.setOrientation(SwingConstants.NORTH_WEST);
  balloon.setPointerDepth(10);
  balloon.setShadowThickness(0);
  balloon.setShadowColor(Color.black);
  balloon.setBorderColor(Color.black);

  // Creates a multiline label
  IlvZoomableLabel label = new IlvZoomableLabel(new IlvPoint(0,0),
          "IlvRectBalloon Example\nThis is a balloon");

  // Adds the balloon and its label
  node.setChildren(0,balloon);
  node.setChildren(1,label);
  manager.addObject(node, true);
 

The following image shows the graphic objects created in the code example:

About Graphic Objects

IlvRectBalloon is a custom graphic object, that is, a subclass of IlvGraphic. Graphic objects are controlled using an IlvManager instance and displayed using one or more IlvManagerView instances in a Java Swing application. For information about generic features for graphic objects, see IlvGraphic.

Since:
JViews 6.0
See Also:
IlvCompositeGraphic, IlvCenteredLayout, IlvManager, IlvManagerView, Serialized Form

Constructor Summary
IlvRectBalloon()
          Creates an IlvRectBalloon
IlvRectBalloon(IlvInputStream stream)
          Reads the object from an IlvInputStream.
IlvRectBalloon(IlvRectBalloon source)
          Creates a new IlvRectBalloon by copying an existing one.
IlvRectBalloon(int orientation, int pointerDepth, int shadowThickness, Color balloonColor, Color borderColor, Color shadowColor)
          Creates a rectangle balloon with the characteristics given by the supplied parameters.
 
Method Summary
 boolean contains(IlvPoint p, IlvPoint tp, IlvTransformer t)
          Tests if a point lies within this balloon.
 IlvGraphic copy()
          Returns a copy of this balloon.
 void draw(Graphics g, IlvTransformer t)
          Draws the object.
 IlvPoint getHotSpot()
          The hotspot is the corner of the pointer relative to bounding box.
 
Methods inherited from class ilog.views.graphic.composite.decoration.IlvBalloon
applyTransform, boundingBox, getBalloonColor, getBorderColor, getInsets, getOrientation, getPointerDepth, getShadowColor, getShadowThickness, moveResize, setBalloonColor, setBorderColor, setInsets, setOrientation, setPointerDepth, setShadowColor, setShadowThickness, write
 
Methods inherited from class ilog.views.IlvGraphic
addActionListener, addNamedPropertyListener, boundingBox, getAndAssociateObjectInteractor, getCenter, getDefaultInteractor, getGraphicBag, GetGraphicObject, getIntersectionWithOutline, getName, getNamedProperty, getObjectInteractor, getPopupMenu, getPopupMenu, getPopupMenuName, getProperty, getToolTipText, getToolTipText, getTopLevelGraphicBag, getTransferData, getTransferDataFlavors, hasProperty, inside, intersects, isDataFlavorSupported, isEditable, isInApplyToObject, isMovable, isPersistent, isSelectable, isVisible, makeSelection, move, move, notifyObjectInteractorToManager, processActionEvent, reDraw, removeActionListener, removeNamedProperty, removeNamedPropertyListener, removeProperty, replaceProperty, resize, rotate, scale, setBackground, setEditable, setFillOn, setForeground, setGraphicBag, setInApplyToObject, setMovable, setName, setNamedProperty, setNameImpl, setObjectInteractor, setPopupMenu, setPopupMenuName, setProperty, setSelectable, setStrokeOn, setToolTipText, setVisible, toString, translate, zoomable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IlvRectBalloon

public IlvRectBalloon()
Creates an IlvRectBalloon


IlvRectBalloon

public IlvRectBalloon(IlvRectBalloon source)
Creates a new IlvRectBalloon by copying an existing one.


IlvRectBalloon

public IlvRectBalloon(int orientation,
                      int pointerDepth,
                      int shadowThickness,
                      Color balloonColor,
                      Color borderColor,
                      Color shadowColor)
Creates a rectangle balloon with the characteristics given by the supplied parameters.

Parameters:
orientation - Balloon orientation.
pointerDepth - Balloon pointer depth.
shadowThickness - Balloon shadow thickness.
balloonColor - Balloon background color.
borderColor - Balloon border color.
shadowColor - Balloon shadow color.
See Also:
IlvBalloon.setOrientation(int), IlvBalloon.setPointerDepth(int), IlvBalloon.setShadowThickness(int), IlvBalloon.setBalloonColor(java.awt.Color), IlvBalloon.setBorderColor(java.awt.Color), IlvBalloon.setShadowColor(java.awt.Color)

IlvRectBalloon

public IlvRectBalloon(IlvInputStream stream)
               throws IlvReadFileException
Reads the object from an IlvInputStream.

Parameters:
stream - The input stream.
Throws:
IlvReadFileException - if the format is not correct.
Method Detail

copy

public IlvGraphic copy()
Returns a copy of this balloon.

Specified by:
copy in class IlvGraphic
Returns:
A new balloon that is a copy of this one.
See Also:
IlvGraphic

getHotSpot

public IlvPoint getHotSpot()
The hotspot is the corner of the pointer relative to bounding box.


draw

public void draw(Graphics g,
                 IlvTransformer t)
Draws the object.

Specified by:
draw in class IlvGraphic
Parameters:
g - The graphic context.
t - The transformer used to draw the object.
See Also:
IlvGraphic.boundingBox(ilog.views.IlvTransformer), IlvGraphic.zoomable(), IlvGraphic

contains

public boolean contains(IlvPoint p,
                        IlvPoint tp,
                        IlvTransformer t)
Tests if a point lies within this balloon.

Overrides:
contains in class IlvGraphic
Parameters:
p - The point to be tested.
tp - The point p transformed by the transformer t.
t - The transformation that was applied to this object when it was drawn.
Returns:
true if the point lies inside this graphic object.
See Also:
IlvGraphic


Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.