IlvAttachmentConstraint (Rogue Wave JViews 9.1 API)

java.lang.Object
- ilog.views.graphic.composite.layout.IlvAttachmentConstraint

All Implemented Interfaces:

IlvPersistentObject, Cloneable
```
public class IlvAttachmentConstraint
extends Object
implements Cloneable, IlvPersistentObject
```
This class represents a constraint between two (x,y) values of attachment points. It is asymmetrical: A graphic object is attached to its "reference object", but the reference object is not attached to its graphic object.

Since:

JViews 6.0

Constructor Summary

Constructors
Constructor and Description
`IlvAttachmentConstraint()` Creates an `IlvAttachmentConstraint` instance with the default values.
`IlvAttachmentConstraint(IlvAttachmentLocation anchor, double dx, double dy)` Creates a new instance of an attachment using the provided location, reference, and offset values.
`IlvAttachmentConstraint(IlvAttachmentLocation hotSpot, IlvAttachmentLocation anchor)` Creates a new instance of an attachment using the provided hotspot, anchor values.
`IlvAttachmentConstraint(IlvAttachmentLocation hotSpot, IlvAttachmentLocation anchor, double dx, double dy)` Creates a new instance of an attachment using the provided hotspot, anchor, and offset values.
`IlvAttachmentConstraint(IlvInputStream stream)` Reads the object from an `IlvInputStream`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Object`	`clone()` Creates and returns a copy of this object.
`IlvPoint`	`compute(IlvAttachable anchor, IlvRect bboxAnchor)` Calculates the anchor point given the location and offset.
`IlvAttachmentLocation`	`getAnchor()` Returns the location of this constraint.
`IlvChildSize`	`getChildSize()` Returns the `IlvChildSize` of this object
`double`	`getHeight()` Returns the height of the child used with this attachment.
`IlvAttachmentLocation`	`getHotSpot()` Returns the location of this constraint.
`IlvPoint`	`getOffset()` Returns the offset being used in the attachment.
`double`	`getOffsetX()` Returns the X coordinate of the offset being used in the attachment.
`double`	`getOffsetY()` Returns the Y coordinate of the offset being used in the attachment.
`double`	`getRelativeHeight()` Deprecated. Beginning with Rogue Wave JViews 8.0, use the method `getHeight()` instead.
`double`	`getRelativeWidth()` Deprecated. Beginning with Rogue Wave JViews 8.0, use the method `getWidth()` instead.
`double`	`getRotationAngle()` Returns the rotation angle
`IlvAttachmentLocation`	`getRotationCenter()` Returns the rotation center on the child used with this attachment.
`IlvPoint`	`getSize()` Returns the size of the child used with this attachment.
`double`	`getWidth()` Returns the width of the child used with this attachment.
`boolean`	`isRelativeOffset()` Returns `true` if the offset being used in the attachment is relative to the bounding box of the first child of the Composite Graphic.
`boolean`	`isRelativeSize()` Returns `true` if the attachment layout uses the relative size properties.
`boolean`	`isRotationCenterRelativeToBase()` Returns whether the attachment defining the rotation center is relative to the base.
`void`	`setAnchor(IlvAttachmentLocation anchor)` Sets the location of this constraint.
`void`	`setChildSize(IlvChildSize childSize)` Defines `IlvChildSize` for this object
`void`	`setHeight(double h)` Sets the height of the child used with this attachment.
`void`	`setHotSpot(IlvAttachmentLocation hotSpot)` Sets the location of this constraint.
`void`	`setOffset(IlvPoint dp)` Sets the offset used by this attachment.
`void`	`setOffsetX(double x)` Sets the X coordinate of the offset being used in the attachment.
`void`	`setOffsetY(double y)` Sets the Y coordinate of the offset being used in the attachment.
`void`	`setRelativeHeight(double h)` Deprecated. Beginning with Rogue Wave JViews 8.0, use the methods `setHeight(double)` and `setRelativeSize(boolean)` instead.
`void`	`setRelativeOffset(boolean relativeOffset)` Indicates whether this attachment uses relative offset or fixed offsets.
`void`	`setRelativeSize(boolean isRelativeSize)` Indicates whether this attachment uses relative sizes or fixed sizes.
`void`	`setRelativeWidth(double w)` Deprecated. Beginning with Rogue Wave JViews 8.0, use the methods `setWidth(double)` and `setRelativeSize(boolean)` instead.
`void`	`setRotationAngle(double angle)` Defines a rotation on the child used with this attachment.
`void`	`setRotationCenter(IlvAttachmentLocation rotationCenter)` Defines the rotation center on the child used with this attachment.
`void`	`setRotationCenterRelativeToBase(boolean rotationCenterRelativeToBase)` Indicates whether the rotation center is relative to the bounding box of the base or relative to the bounding box of the child corresponding to this attachment constraint.
`void`	`setSize(IlvPoint size)` Sets the size of the child used with this attachment.
`void`	`setWidth(double w)` Sets the width of the child used with this attachment.
`void`	`write(IlvOutputStream stream)` Writes the attributes of a persistent object.

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

- Constructor Detail
  - IlvAttachmentConstraint
```
public IlvAttachmentConstraint()
```
    Creates an IlvAttachmentConstraint instance with the default values.
  - IlvAttachmentConstraint
```
public IlvAttachmentConstraint(IlvAttachmentLocation anchor,
                               double dx,
                               double dy)
```
    Creates a new instance of an attachment using the provided location, reference, and offset values.
    
    Parameters:
    
    anchor - The position in the attachable object where the attachment will be done. For example, the top side of the object is attached to another object top location.
    
    dx - The horizontal offset.
    
    dy - The vertical offset.
    
    See Also:
    
    IlvAttachmentLocation
  - IlvAttachmentConstraint
```
public IlvAttachmentConstraint(IlvAttachmentLocation hotSpot,
                               IlvAttachmentLocation anchor,
                               double dx,
                               double dy)
```
    Creates a new instance of an attachment using the provided hotspot, anchor, and offset values.
    
    Parameters:
    
    hotSpot - The position in the attachable object where the attachment will take place. For example, the top side of the attachable object will be attached to the bottom side of another object.
    
    anchor - The position in the reference object where the attachment will take place.
    
    dx - The horizontal offset.
    
    dy - The vertical offset.
    
    See Also:
    
    IlvAttachmentLocation
  - IlvAttachmentConstraint
```
public IlvAttachmentConstraint(IlvAttachmentLocation hotSpot,
                               IlvAttachmentLocation anchor)
```
    Creates a new instance of an attachment using the provided hotspot, anchor values.
    
    Parameters:
    
    hotSpot - The position in the attachable object where the attachment will take place. For example, the top side of the attachable object will be attached to the bottom side of another object.
    
    anchor - The position in the reference object where the attachment will take place.
    
    See Also:
    
    IlvAttachmentLocation
  - IlvAttachmentConstraint
```
public IlvAttachmentConstraint(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
  - getHotSpot
```
public IlvAttachmentLocation getHotSpot()
```
    Returns the location of this constraint. It is meant to be applied to the reference object.
  - setHotSpot
```
public void setHotSpot(IlvAttachmentLocation hotSpot)
```
    Sets the location of this constraint. It is meant to be applied to the local object.
  - getAnchor
```
public IlvAttachmentLocation getAnchor()
```
    Returns the location of this constraint. It is meant to be applied to the reference object.
  - setAnchor
```
public void setAnchor(IlvAttachmentLocation anchor)
```
    Sets the location of this constraint. It is meant to be applied to the reference object.
  - getOffset
```
public IlvPoint getOffset()
```
    Returns the offset being used in the attachment.
  - setOffset
```
public void setOffset(IlvPoint dp)
```
    Sets the offset used by this attachment.
  - getOffsetX
```
public double getOffsetX()
```
    Returns the X coordinate of the offset being used in the attachment.
    
    Since:
    
    JViews 7.5
  - setOffsetX
```
public void setOffsetX(double x)
```
    Sets the X coordinate of the offset being used in the attachment.
    
    Since:
    
    JViews 7.5
  - getOffsetY
```
public double getOffsetY()
```
    Returns the Y coordinate of the offset being used in the attachment.
    
    Since:
    
    JViews 7.5
  - setOffsetY
```
public void setOffsetY(double y)
```
    Sets the Y coordinate of the offset being used in the attachment.
    
    Since:
    
    JViews 7.5
  - isRelativeOffset
```
public boolean isRelativeOffset()
```
    Returns true if the offset being used in the attachment is relative to the bounding box of the first child of the Composite Graphic.
  - setRelativeOffset
```
public void setRelativeOffset(boolean relativeOffset)
```
    Indicates whether this attachment uses relative offset or fixed offsets.
    
    Parameters:
    
    relativeOffset - When true, the offset values are ratios of the bounding box of the first child of the Composite Graphic.
  - getSize
```
public IlvPoint getSize()
```
    Returns the size of the child used with this attachment.
    
    Returns:
    
    Returns the size of the child defined as a ratio of the bounding box of the base(first child of the composite graphic)
  - setSize
```
public void setSize(IlvPoint size)
```
    Sets the size of the child used with this attachment.
    
    Parameters:
    
    size - The size is either defined as a ratio of the bounding box of the composite graphic or in pixel unit. By default, the units are ratios
  - getWidth
```
public double getWidth()
```
    Returns the width of the child used with this attachment.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    setSize(ilog.views.IlvPoint), getSize()
  - setWidth
```
public void setWidth(double w)
```
    Sets the width of the child used with this attachment.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    setSize(ilog.views.IlvPoint), getSize()
  - getHeight
```
public double getHeight()
```
    Returns the height of the child used with this attachment.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    setSize(ilog.views.IlvPoint), getSize()
  - setHeight
```
public void setHeight(double h)
```
    Sets the height of the child used with this attachment.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    setSize(ilog.views.IlvPoint), getSize()
  - isRelativeSize
```
public boolean isRelativeSize()
```
    Returns true if the attachment layout uses the relative size properties. Returns false otherwise.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    IlvAttachmentLayout
  - setRelativeSize
```
public void setRelativeSize(boolean isRelativeSize)
```
    Indicates whether this attachment uses relative sizes or fixed sizes.
    
    Parameters:
    
    isRelativeSize - When true, the attachment layout uses the relative size properties:t the size is defined as a ratio of the bounding box of the composite graphic. For example, (0.5,0.25) means that the child will have a width equal to 50% of the width of the base (the first child of the composite graphic) and a height equal to 25% of the height of the base.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    setHeight(double), getHeight(), setWidth(double), getWidth(), setSize(ilog.views.IlvPoint), getSize(), IlvAttachmentLayout
  - getRelativeWidth
```
@Deprecated
public double getRelativeWidth()
```
    Deprecated. Beginning with Rogue Wave JViews 8.0, use the method getWidth() instead.
    
    Returns the width of the child used with this attachment.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    setSize(ilog.views.IlvPoint), getSize()
  - setRelativeWidth
```
@Deprecated
public void setRelativeWidth(double w)
```
    Deprecated. Beginning with Rogue Wave JViews 8.0, use the methods setWidth(double) and setRelativeSize(boolean) instead.
    
    Sets the width of the child used with this attachment.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    setSize(ilog.views.IlvPoint), getSize()
  - getRelativeHeight
```
@Deprecated
public double getRelativeHeight()
```
    Deprecated. Beginning with Rogue Wave JViews 8.0, use the method getHeight() instead.
    
    Returns the height of the child used with this attachment.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    setSize(ilog.views.IlvPoint), getSize()
  - setRelativeHeight
```
@Deprecated
public void setRelativeHeight(double h)
```
    Deprecated. Beginning with Rogue Wave JViews 8.0, use the methods setHeight(double) and setRelativeSize(boolean) instead.
    
    Sets the height of the child used with this attachment.
    
    Since:
    
    JViews 7.5
    
    See Also:
    
    setSize(ilog.views.IlvPoint), getSize()
  - setRotationAngle
```
public void setRotationAngle(double angle)
```
    Defines a rotation on the child used with this attachment.
    
    Parameters:
    
    angle - The rotation angle in degrees.
  - getRotationAngle
```
public double getRotationAngle()
```
    Returns the rotation angle
    
    Returns:
    
    The rotation angle in degrees.
  - setRotationCenter
```
public void setRotationCenter(IlvAttachmentLocation rotationCenter)
```
    Defines the rotation center on the child used with this attachment.
  - getRotationCenter
```
public IlvAttachmentLocation getRotationCenter()
```
    Returns the rotation center on the child used with this attachment.
  - setChildSize
```
public void setChildSize(IlvChildSize childSize)
```
    Defines IlvChildSize for this object
  - getChildSize
```
public IlvChildSize getChildSize()
```
    Returns the IlvChildSize of this object
  - isRotationCenterRelativeToBase
```
public boolean isRotationCenterRelativeToBase()
```
    Returns whether the attachment defining the rotation center is relative to the base.
    
    Since:
    
    JViews 8.0
    
    See Also:
    
    setRotationCenter(ilog.views.graphic.composite.layout.IlvAttachmentLocation), getRotationCenter()
  - setRotationCenterRelativeToBase
```
public void setRotationCenterRelativeToBase(boolean rotationCenterRelativeToBase)
```
    Indicates whether the rotation center is relative to the bounding box of the base or relative to the bounding box of the child corresponding to this attachment constraint.
    
    Parameters:
    
    rotationCenterRelativeToBase - true means that the rotation center is relative to the bounding box of the base
    
    Since:
    
    JViews 8.0
  - clone
```
public Object clone()
```
    Creates and returns a copy of this object.
    
    Overrides:
    
    clone in class Object
  - compute
```
public IlvPoint compute(IlvAttachable anchor,
                        IlvRect bboxAnchor)
```
    Calculates the anchor point given the location and offset.
  - write
```
public void write(IlvOutputStream stream)
           throws IOException
```
    Writes the attributes of a persistent object.
    
    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.

Class IlvAttachmentConstraint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IlvAttachmentConstraint

IlvAttachmentConstraint

IlvAttachmentConstraint

IlvAttachmentConstraint

IlvAttachmentConstraint

Method Detail

getHotSpot

setHotSpot

getAnchor

setAnchor

getOffset

setOffset

getOffsetX

setOffsetX

getOffsetY

setOffsetY

isRelativeOffset

setRelativeOffset

getSize

setSize

getWidth

setWidth

getHeight

setHeight

isRelativeSize

setRelativeSize

getRelativeWidth

setRelativeWidth

getRelativeHeight

setRelativeHeight

setRotationAngle

getRotationAngle

setRotationCenter

getRotationCenter

setChildSize

getChildSize

isRotationCenterRelativeToBase

setRotationCenterRelativeToBase

clone

compute

write