public abstract class InteractiveObject
extends java.lang.Object
| Modifier | Constructor and Description |
|---|---|
protected |
InteractiveObject(Worksheet worksheet)
Initializes a new instance of the
InteractiveObject class. |
| Modifier and Type | Method and Description |
|---|---|
void |
bringForward()
Moves this object one step up in the z-order.
|
void |
bringToFront()
Brings this object to the top of the z-order.
|
void |
dispose()
Disposes this object of any unmanaged resources it might hold.
|
void |
draw(IRenderTarget target,
RenderContext context,
java.awt.Rectangle rect) |
Measure |
getActualHeight() |
Measure |
getActualWidth() |
ObjectAnchor |
getAnchor()
Gets the anchor of this object.
|
ObjectAnchorPosition |
getAnchorPosition()
Gets the anchor position of this object.
|
java.lang.String |
getDescription()
Gets the object description.
|
protected boolean |
getExtendsOutsideBounds()
Gets a value indicating whether this object's visual can extend beyond the object's bounding rectangle.
|
int |
getFromColumn()
Gets the zero-based index of the column of the cell to which the object is anchored.
|
int |
getFromRow()
Gets the zero-based index of the row of the cell to which the object is anchored.
|
Measure |
getHeight()
Gets the desired height, or
null, to calculate the height automatically. |
Measure |
getHorizontalOffset()
Gets the horizontal offset of the object from its anchor.
|
java.awt.Color |
getLineColor()
Gets the outline color of this object.
|
Measure |
getLineSize()
Gets the thickness of the object's outline.
|
DashStyle |
getLineStyle()
Gets the style of the object's outline.
|
boolean |
getLocked()
Gets a value indicating whether this object can be interacted with.
|
protected boolean |
getRegardsMergedCells()
Gets a value indicating whether this object is positioned relatively to the bounding rectangle
of the merged cell if the object's cell is a part of a merged cell.
|
java.lang.String |
getTitle()
Gets the object title.
|
Measure |
getVerticalOffset()
Gets the vertical offset of the object from its origin.
|
Measure |
getWidth()
Gets the desired width, or
null, to calculate width automatically. |
Worksheet |
getWorksheet()
Gets the parent worksheet.
|
void |
invalidate()
Raises an event notifying that this object changed visually.
|
boolean |
isLockedToCell()
Gets a value indicating whether this object is always locked to a cell in the worksheet.
|
void |
onAttach()
This method is called when the object is added to a worksheet.
|
void |
onDetach()
This method is called when the object is removed from a worksheet.
|
void |
onPropertyChanged(java.lang.Object target,
java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue) |
void |
onPropertyChanged(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
This method is called when the value of a property of this object is changed.
|
protected void |
onResized()
This method is called when the object's size is changed.
|
void |
onWorksheetPropertyChanged(java.beans.PropertyChangeEvent e)
Called when a property of the worksheet this chart belongs to is changed.
|
java.lang.Object |
refactorReferences(java.util.function.Function<CellRef,CellRef> func)
Transforms all cell references in this object using the specified function.
|
void |
restoreReferences(java.lang.Object state)
Restores the cell references in this object to the values before RefactorReferences call.
|
void |
sendBackward()
Moves this object one step down in the z-order.
|
void |
sendToBack()
Sends this object to the bottom of the z-order.
|
void |
setAnchor(ObjectAnchor value)
Sets the anchor of this object.
|
void |
setAnchorPosition(ObjectAnchorPosition value)
Sets the anchor position of this object.
|
void |
setDescription(java.lang.String value)
Sets the object description.
|
void |
setFromColumn(int value)
Sets the zero-based index of the column of the cell to which the object is anchored.
|
void |
setFromRow(int value)
Sets the zero-based index of the row of the cell to which the object is anchored.
|
void |
setHeight(Measure value)
Sets the desired height, or
null, to calculate the height automatically. |
void |
setHorizontalOffset(Measure value)
Sets the horizontal offset of the object from its anchor.
|
void |
setLineColor(java.awt.Color value)
Sets the outline color of this object.
|
void |
setLineSize(Measure value)
Sets the thickness of the object's outline.
|
void |
setLineStyle(DashStyle value)
Sets the style of the object's outline.
|
void |
setLocked(boolean value)
Sets a value indicating whether this object can be interacted with.
|
void |
setTitle(java.lang.String value)
Sets the object title.
|
void |
setVerticalOffset(Measure value)
Sets the vertical offset of the object from its origin.
|
void |
setWidth(Measure value)
Sets the desired width, or
null, to calculate width automatically. |
protected InteractiveObject(Worksheet worksheet)
InteractiveObject class.worksheet - The Worksheet this object belongs to.public void dispose()
protected void onResized()
public void onPropertyChanged(java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
public void onWorksheetPropertyChanged(java.beans.PropertyChangeEvent e)
public void onPropertyChanged(java.lang.Object target,
java.lang.String propertyName,
java.lang.Object oldValue,
java.lang.Object newValue)
public void onAttach()
public void onDetach()
public void invalidate()
public void bringToFront()
public void sendToBack()
public void bringForward()
public void sendBackward()
public void draw(IRenderTarget target, RenderContext context, java.awt.Rectangle rect)
public Measure getActualWidth()
public Measure getActualHeight()
public java.lang.Object refactorReferences(java.util.function.Function<CellRef,CellRef> func)
public void restoreReferences(java.lang.Object state)
public Worksheet getWorksheet()
public ObjectAnchor getAnchor()
public void setAnchor(ObjectAnchor value)
public ObjectAnchorPosition getAnchorPosition()
This value is relevant only if the Anchor property is set to ObjectAnchor.ToCell.
public void setAnchorPosition(ObjectAnchorPosition value)
This value is relevant only if the Anchor property is set to ObjectAnchor.ToCell.
public int getFromColumn()
This value is ignored if the object is anchored to the page.
public void setFromColumn(int value)
This value is ignored if the object is anchored to the page.
public int getFromRow()
This value is ignore if the object is anchored to the page.
public void setFromRow(int value)
This value is ignore if the object is anchored to the page.
public Measure getHorizontalOffset()
public void setHorizontalOffset(Measure value)
public Measure getVerticalOffset()
public void setVerticalOffset(Measure value)
public java.lang.String getTitle()
public void setTitle(java.lang.String value)
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public Measure getWidth()
null, to calculate width automatically.public void setWidth(Measure value)
null, to calculate width automatically.public Measure getHeight()
null, to calculate the height automatically.public void setHeight(Measure value)
null, to calculate the height automatically.public java.awt.Color getLineColor()
public void setLineColor(java.awt.Color value)
public Measure getLineSize()
public void setLineSize(Measure value)
public DashStyle getLineStyle()
public void setLineStyle(DashStyle value)
public boolean getLocked()
public void setLocked(boolean value)
public boolean isLockedToCell()
protected boolean getExtendsOutsideBounds()
protected boolean getRegardsMergedCells()