IlvExpandCollapseMarker (Rogue Wave JViews 9.0 API)

java.lang.Object
- ilog.views.IlvGraphic
- - ilog.views.graphic.IlvExpandCollapseMarker

All Implemented Interfaces:

IlvPersistentObject, IlvBlinkingObject, IlvBaseTextDirectionInterface, Transferable, Serializable
```
public class IlvExpandCollapseMarker
extends IlvGraphic
```
IlvExpandCollapseMarker displays an icon to expand or collapse a frame. The icon contains a "[+]" symbol to expand, and a "[-]" symbol to collapse.
The default values for an IlvExpandCollapseMarker instance are as follows:
- Foreground: Color.black
- Background: Color.white
- TopLeftBorder: Color(60,178,113)
- BottomRightBorder: Color(0,128,0)
- Size: 9
- Position: IlvPoint(0,0)
- ExpandedIcon: true
- Zoomable: true
Example

The IlvExpandCollapseMarker is mostly used as expand or collapse icon at manager or link bundle frames. It can also be used as regular graphic object. The following code example shows how to use an IlvExpandCollapseMarker in a simple Java application:
```
   IlvManager manager = new IlvManager();
   IlvExpandCollapseMarker myMarker =
       new IlvExpandCollapseMarker(new IlvPoint(120,100), true);
   myMarker.setForeground(Color.cyan);
   myMarker.setSize(9);
   manager.addObject( myMarker, true);
 
```
About Graphic Objects

IlvExpandCollapseMarker 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 8.8

See Also:

IlvPoint, IlvManager, IlvManagerView, Serialized Form

Constructor Summary

Constructors
Constructor and Description
`IlvExpandCollapseMarker()` Creates a new `IlvExpandCollapseMarker` as "[-]" symbol centered in `(0, 0)`.
`IlvExpandCollapseMarker(IlvExpandCollapseMarker source)` Creates a marker by copying an existing one.
`IlvExpandCollapseMarker(IlvInputStream stream)` Reads the object from an `IlvInputStream`.
`IlvExpandCollapseMarker(IlvPoint p, boolean expanded, int size)` Creates a new expand / collapse marker.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyTransform(IlvTransformer t)` Applies a transformation to the object.
`IlvRect`	`boundingBox(IlvTransformer t)` Returns the bounding rectangle of the object.
`protected IlvRect`	`calcBoundingBox(IlvTransformer t)` Calculates the bounding rectangle of the object.
`IlvGraphic`	`copy()` Copies the object.
`void`	`draw(Graphics dst, IlvTransformer t)` Draws the object.
`Color`	`getBackground()` Returns the background color of the marker.
`Color`	`getBottomRightBorder()` Returns the color of the bottom right border rectangle of the marker.
`Color`	`getForeground()` Returns the foreground color of the marker.
`IlvPoint`	`getPoint()` Returns the top left corner point of the marker.
`int`	`getSize()` Returns the size of rectangle of the marker.
`Color`	`getTopLeftBorder()` Returns the color of the top left border rectangle of the marker.
`boolean`	`isExpandedIcon()` Returns whether the marker shows the expanded icon "[-]" or the collapsed icon "[+]".
`boolean`	`isZoomable()` Returns whether the marker follows the zoom level.
`IlvSelection`	`makeSelection()` Creates a selection object for this graphic object.
`void`	`setBackground(Color color)` Changes the background color of the marker.
`void`	`setBottomRightBorder(Color color)` Changes the color of the bottom right border rectangle of the marker.
`void`	`setExpandedIcon(boolean expanded)` Sets whether the marker shows the expanded icon "[-]" or the collapsed icon "[+]".
`void`	`setForeground(Color color)` Changes the foreground color of the marker.
`void`	`setPoint(IlvPoint p)` Changes the top left corner point of the marker.
`void`	`setSize(int size)` Changes the size of the rectangle of the marker.
`void`	`setTopLeftBorder(Color color)` Changes the color of the top left border rectangle of the marker.
`void`	`setZoomable(boolean zoomable)` Sets whether the marker follows the zoom level.
`void`	`write(IlvOutputStream stream)` Writes the object to an `IlvOutputStream`.
`boolean`	`zoomable()` Returns `true` if the object is zoomable; otherwise it returns `false`.

Methods inherited from class ilog.views.IlvGraphic
addActionListener, addNamedPropertyListener, allViewsRemoved, baseTextDirectionChanged, blinkingStateOn, boundingBox, callDraw, componentOrientationChanged, contains, getAndAssociateObjectInteractor, getBaseTextDirection, getBlinkingAction, getBlinkingObjectOwner, getBlinkingOffPeriod, getBlinkingOnPeriod, getCenter, getComponentOrientation, getDefaultInteractor, getGraphicBag, GetGraphicObject, getIntersectionWithOutline, getLocale, getName, getNamedProperty, getObjectInteractor, getPopupMenu, getPopupMenu, getPopupMenuName, getProperty, getResolvedBaseTextDirection, getToolTipBaseTextDirection, getToolTipText, getToolTipText, getTopLevelGraphicBag, getTransferData, getTransferDataFlavors, getULocale, getZOrderIndex, hasProperty, inside, intersects, invalidateBBoxCache, invalidateBidiCache, isBaseTextDirectionSensitive, isComponentOrientationSensitive, isDataFlavorSupported, isEditable, isInApplyToObject, isLocaleSensitive, isMovable, isPersistent, isSelectable, isVisible, localeChanged, move, move, moveResize, needsViewNotification, notifyObjectInteractorToManager, processActionEvent, reDraw, registerBlinkingResource, removeActionListener, removeNamedProperty, removeNamedPropertyListener, removeProperty, replaceProperty, resize, rotate, scale, setBaseTextDirection, setBaseTextDirectionDuringConstruction, setBlinkingAction, setBlinkingOffPeriod, setBlinkingOnPeriod, setEditable, setFillOn, setGraphicBag, setInApplyToObject, setMovable, setName, setNamedProperty, setNameImpl, setObjectInteractor, setPopupMenu, setPopupMenuName, setProperty, setSelectable, setStrokeOn, setToolTipBaseTextDirection, setToolTipText, setVisible, setZOrderIndex, toString, translate, updateNeedsViewNotification, usesBidiMarkers, viewAddedOrRemoved

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - IlvExpandCollapseMarker
```
public IlvExpandCollapseMarker()
```
    Creates a new IlvExpandCollapseMarker as "[-]" symbol centered in (0, 0).
    
    See Also:
    
    IlvExpandCollapseMarker(IlvPoint, boolean, int)
  - IlvExpandCollapseMarker
```
public IlvExpandCollapseMarker(IlvPoint p,
                               boolean expanded,
                               int size)
```
    Creates a new expand / collapse marker.
    
    Parameters:
    
    p - The location of the marker. It defines the top left corner point of the marker.
    
    expanded - If true, it displays a "[-]" symbol, if false, it displays a "[+]" symbol.
    
    size - The size of the rectangle containing the symbol.
  - IlvExpandCollapseMarker
```
public IlvExpandCollapseMarker(IlvExpandCollapseMarker source)
```
    Creates a marker by copying an existing one.
    
    Parameters:
    
    source - The source marker.
  - IlvExpandCollapseMarker
```
public IlvExpandCollapseMarker(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()
```
    Copies the object. This method copies the object by calling the copy constructor.
    
    Specified by:
    
    copy in class IlvGraphic
    
    Returns:
    
    A copy of the object.
    
    See Also:
    
    IlvGraphic
  - getPoint
```
public IlvPoint getPoint()
```
    Returns the top left corner point of the marker.
    
    See Also:
    
    setPoint(ilog.views.IlvPoint)
  - setPoint
```
public void setPoint(IlvPoint p)
```
    Changes the top left corner point of the marker. Doing so modifies the bounding box of the marker.
    
    Parameters:
    
    p - The new top left corner point.
    
    See Also:
    
    getPoint()
  - isExpandedIcon
```
public boolean isExpandedIcon()
```
    Returns whether the marker shows the expanded icon "[-]" or the collapsed icon "[+]".
    
    See Also:
    
    setExpandedIcon(boolean)
  - setExpandedIcon
```
public void setExpandedIcon(boolean expanded)
```
    Sets whether the marker shows the expanded icon "[-]" or the collapsed icon "[+]".
    
    Parameters:
    
    expanded - If true, it displays a "[-]" symbol, if false, it displays a "[+]" symbol.
    
    See Also:
    
    isExpandedIcon()
  - getSize
```
public int getSize()
```
    Returns the size of rectangle of the marker.
    
    See Also:
    
    setSize(int)
  - setSize
```
public void setSize(int size)
```
    Changes the size of the rectangle of the marker.
    
    Parameters:
    
    size - The size of the marker.
    
    See Also:
    
    getSize()
  - isZoomable
```
public boolean isZoomable()
```
    Returns whether the marker follows the zoom level.
    
    See Also:
    
    setZoomable(boolean)
  - setZoomable
```
public void setZoomable(boolean zoomable)
```
    Sets whether the marker follows the zoom level.
    Note: If this object is contained inside an IlvManager, users must use the method IlvManager.applyToObject(ilog.views.IlvGraphic, ilog.views.IlvApplyObject, java.lang.Object, boolean) for this operation.
    
    See Also:
    
    isZoomable()
  - zoomable
```
public boolean zoomable()
```
    Returns true if the object is zoomable; otherwise it returns false.
    
    Overrides:
    
    zoomable in class IlvGraphic
    
    See Also:
    
    IlvGraphic, IlvGraphic.draw(java.awt.Graphics, ilog.views.IlvTransformer), IlvGraphic.boundingBox(IlvTransformer), IlvManager
  - setForeground
```
public void setForeground(Color color)
```
    Changes the foreground color of the marker. This is the color of the + or - sign. This property supports IlvBlinkingColor.
    
    Overrides:
    
    setForeground in class IlvGraphic
    
    Parameters:
    
    color - The new color.
    
    See Also:
    
    IlvGraphic.draw(Graphics, IlvTransformer), IlvGraphic.setBackground(Color), IlvGraphic.setFillOn(boolean), IlvGraphic.setStrokeOn(boolean), IlvGraphic
  - getForeground
```
public Color getForeground()
```
    Returns the foreground color of the marker.
    
    Returns:
    
    The foreground color of the object.
  - setBackground
```
public void setBackground(Color color)
```
    Changes the background color of the marker. This is the fill color of the rectangle. This property supports IlvBlinkingColor.
    
    Overrides:
    
    setBackground in class IlvGraphic
    
    Parameters:
    
    color - The new color.
    
    See Also:
    
    IlvGraphic.draw(Graphics, IlvTransformer), IlvGraphic.setForeground(Color), IlvGraphic.setFillOn(boolean), IlvGraphic.setStrokeOn(boolean), IlvGraphic
  - getBackground
```
public Color getBackground()
```
    Returns the background color of the marker.
    
    Returns:
    
    The background color of the object.
  - setTopLeftBorder
```
public void setTopLeftBorder(Color color)
```
    Changes the color of the top left border rectangle of the marker. This property supports IlvBlinkingColor.
    
    Parameters:
    
    color - The new color.
  - getTopLeftBorder
```
public Color getTopLeftBorder()
```
    Returns the color of the top left border rectangle of the marker.
    
    Returns:
    
    The color of the top left border rectangle of the object.
  - setBottomRightBorder
```
public void setBottomRightBorder(Color color)
```
    Changes the color of the bottom right border rectangle of the marker. This property supports IlvBlinkingColor.
    
    Parameters:
    
    color - The new color.
  - getBottomRightBorder
```
public Color getBottomRightBorder()
```
    Returns the color of the bottom right border rectangle of the marker.
    
    Returns:
    
    The color of the bottom right border rectangle of the object.
  - draw
```
public void draw(Graphics dst,
                 IlvTransformer t)
```
    Draws the object.
    
    Specified by:
    
    draw in class IlvGraphic
    
    Parameters:
    
    dst - The destination Graphics.
    
    t - The transformation used to draw the object.
    
    See Also:
    
    IlvGraphic.callDraw(Graphics,IlvTransformer), IlvGraphic.boundingBox(IlvTransformer), IlvGraphic.zoomable(), IlvGraphic
  - boundingBox
```
public IlvRect boundingBox(IlvTransformer t)
```
    Returns the bounding rectangle of the object. First checks whether the bounding rectangle is cached. If it is not cached it calls calcBoundingBox(ilog.views.IlvTransformer) to recalculate the bounding box.
    
    Specified by:
    
    boundingBox in class IlvGraphic
    
    Parameters:
    
    t - The transformer used to draw the object.
    
    See Also:
    
    IlvGraphic.draw(java.awt.Graphics, ilog.views.IlvTransformer), IlvGraphic.zoomable(), IlvGraphic
  - calcBoundingBox
```
protected IlvRect calcBoundingBox(IlvTransformer t)
```
    Calculates the bounding rectangle of the object. This method is used by boundingBox(ilog.views.IlvTransformer) if the current bounding box is not cached.
    
    Parameters:
    
    t - The transformer used to draw the object.
    
    Returns:
    
    A freshly allocated rectangle.
  - applyTransform
```
public void applyTransform(IlvTransformer t)
```
    Applies a transformation to the object. The implementation of this method simply applies the transformation to the center point of the marker (see getPoint()).
    
    Specified by:
    
    applyTransform in class IlvGraphic
    
    Parameters:
    
    t - The transformer to be applied.
    
    See Also:
    
    IlvGraphic
  - makeSelection
```
public IlvSelection makeSelection()
```
    Creates a selection object for this graphic object. Because this object cannot be resized using the interactor, the implementation of this method creates an instance of the class IlvUnresizeableDrawSelection.
    
    Overrides:
    
    makeSelection in class IlvGraphic
    
    See Also:
    
    IlvDrawSelection
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the object to an IlvOutputStream. You should not call this method directly; instead, you should use the write methods of the manager.
    
    Specified by:
    
    write in interface IlvPersistentObject
    
    Overrides:
    
    write in class IlvGraphic
    
    Parameters:
    
    stream - The output stream.
    
    Throws:
    
    IOException - thrown when an exception occurs during the write operation for this object.

Class IlvExpandCollapseMarker

Example

About Graphic Objects

Constructor Summary

Method Summary

Methods inherited from class ilog.views.IlvGraphic

Methods inherited from class java.lang.Object

Constructor Detail

IlvExpandCollapseMarker

IlvExpandCollapseMarker

IlvExpandCollapseMarker

IlvExpandCollapseMarker

Method Detail

copy

getPoint

setPoint

isExpandedIcon

setExpandedIcon

getSize

setSize

isZoomable

setZoomable

zoomable

setForeground

getForeground

setBackground

getBackground

setTopLeftBorder

getTopLeftBorder

setBottomRightBorder

getBottomRightBorder

draw

boundingBox

calcBoundingBox

applyTransform

makeSelection

write