com.f1j.drawing
Interface Shape

All Known Subinterfaces:

FcChart, Picture, ShapeRange

public interface Shape

extends com.f1j.drawing.ShapeConstants, Lockable

This interface describes the public API for a shape.

Method Summary

void	bringForward() Brings this shape forward
void	bringToFront() Brings this shape to the front of all shapes
boolean	canChangeType() Returns whether or not this shape's type can change
boolean	canFlip() Returns whether or not this shape can flip
boolean	canRegroup() Returns whether or not this shape can be part of a regroup operation
boolean	canUngroup() Returns whether or not this shape can be part of an ungroup operation
void	delete() Delete this shape from the drawing.
void	flipHorizontal() Flip this shape horizontally.
void	flipVertical() Flip this shape vertically.
EAutoShape	getAutoShapeType() Returns the auto shape type.
Format	getFormat() Returns the Format object associated with this shape.
int	getID() Returns the shape's ID.
java.lang.String	getName() Returns the shape's name.
ShapeAnchor	getShapeAnchor() Returns the shape's ShapeAnchor.
java.lang.String	getText() Returns the shape's text.
EShape	getType() Returns the shape's type.
int	getZOrderPosition() Returns the shape's Z-Order position.
boolean	hasText() Returns whether or not the shape has had text added to it.
boolean	isAllowChanges() Returns whether or not the shape can be changed.
boolean	isAllowSelection() Returns whether or not the shape can be selected.
boolean	isAllowText() Returns whether or not the shape can have text added to it.
boolean	isHorizontalFlip() Returns whether or not the shape is flipped horizontally.
boolean	isVerticalFlip() Returns whether or not the shape is flipped vertically.
void	sendBackward() Send the shape backward.
void	sendToBack() Send the shape to the back of all shapes.
void	setAutoShapeType(EAutoShape eType) Sets the auto shape type of this shape.
void	setFormat(Format format) Sets the Format for this shape.
void	setName(java.lang.String strName) Sets the shape's name.
void	setShapeAnchor(ShapeAnchor shapeAnchor) Sets the shape's ShapeAnchor.
void	setText(java.lang.String text) Sets the shape's text.
short	setZOrder(EZOrder eZOrderCmd) Sets the shape's Z-Order.

Methods inherited from interface com.f1j.util.Lockable

getLock, releaseLock

Method Detail

bringForward

public void bringForward()
                  throws AccessDeniedException,
                         F1Exception

Brings this shape forward

bringToFront

public void bringToFront()
                  throws AccessDeniedException,
                         F1Exception

Brings this shape to the front of all shapes

canChangeType

public boolean canChangeType()

Returns whether or not this shape's type can change

Returns:

whether or not this shape's type can change

canFlip

public boolean canFlip()

Returns whether or not this shape can flip

Returns:

whether or not this shape can flip

canRegroup

public boolean canRegroup()

Returns whether or not this shape can be part of a regroup operation

Returns:

whether or not this shape can be part of a regroup operation

canUngroup

public boolean canUngroup()

Returns whether or not this shape can be part of an ungroup operation

Returns:

whether or not this shape can be part of an ungroup operation

delete

public void delete()
            throws AccessDeniedException,
                   F1Exception

Delete this shape from the drawing.

flipHorizontal

public void flipHorizontal()
                    throws AccessDeniedException,
                           UnsupportedFeatureException,
                           F1Exception

Flip this shape horizontally.

flipVertical

public void flipVertical()
                  throws AccessDeniedException,
                         UnsupportedFeatureException,
                         F1Exception

Flip this shape vertically.

getAutoShapeType

public EAutoShape getAutoShapeType()
                            throws F1Exception

Returns the auto shape type.

Returns:

the auto shape type. Null if not an autoshape.

getFormat

public Format getFormat()

Returns the Format object associated with this shape.

Returns:

the Format object associated with this shape.

getID

public int getID()
          throws UnsupportedFeatureException,
                 F1Exception

Returns the shape's ID.

Returns:

the shape's ID.

getName

public java.lang.String getName()
                         throws UnsupportedFeatureException,
                                F1Exception

Returns the shape's name.

Returns:

the shape's name. If no name has been assigned, a default name is returned.

getShapeAnchor

public ShapeAnchor getShapeAnchor()

Returns the shape's ShapeAnchor.

Returns:

the shape's ShapeAnchor.

getText

public java.lang.String getText()
                         throws UnsupportedFeatureException,
                                F1Exception

Returns the shape's text.

Returns:

the shape's text. Null if no text has been added to this shape.

getType

public EShape getType()
               throws F1Exception

Returns the shape's type.

Returns:

the shape's type.

getZOrderPosition

public int getZOrderPosition()
                      throws F1Exception

Returns the shape's Z-Order position.

Returns:

the shape's Z-Order position.

hasText

public boolean hasText()
                throws UnsupportedFeatureException,
                       F1Exception

Returns whether or not the shape has had text added to it.

Returns:

whether or not the shape has had text added to it.

isAllowChanges

public boolean isAllowChanges()

Returns whether or not the shape can be changed.

Returns:

whether or not the shape can be changed.

isAllowSelection

public boolean isAllowSelection()

Returns whether or not the shape can be selected.

Returns:

whether or not the shape can be selected.

isAllowText

public boolean isAllowText()
                    throws UnsupportedFeatureException,
                           F1Exception

Returns whether or not the shape can have text added to it.

Returns:

whether or not the shape can have text added to it.

isHorizontalFlip

public boolean isHorizontalFlip()

Returns whether or not the shape is flipped horizontally.

Returns:

whether or not the shape is flipped horizontally.

isVerticalFlip

public boolean isVerticalFlip()

Returns whether or not the shape is flipped vertically.

Returns:

whether or not the shape is flipped vertically.

sendBackward

public void sendBackward()
                  throws AccessDeniedException,
                         F1Exception

Send the shape backward.

sendToBack

public void sendToBack()
                throws AccessDeniedException,
                       F1Exception

Send the shape to the back of all shapes.

setAutoShapeType

public void setAutoShapeType(EAutoShape eType)

Sets the auto shape type of this shape.

Parameters:

eType - the auto shape type.

setFormat

public void setFormat(Format format)

Sets the Format for this shape.

Parameters:

format - the format.

setName

public void setName(java.lang.String strName)
             throws UnsupportedFeatureException,
                    F1Exception

Sets the shape's name.

Parameters:

strName - the name.

setShapeAnchor

public void setShapeAnchor(ShapeAnchor shapeAnchor)
                    throws AccessDeniedException,
                           SelectionException,
                           F1Exception

Sets the shape's ShapeAnchor.

Parameters:

shapeAnchor - the ShapeAnchor.

setText

public void setText(java.lang.String text)
             throws UnsupportedFeatureException,
                    F1Exception

Sets the shape's text.

Parameters:

text - the text.

setZOrder

public short setZOrder(EZOrder eZOrderCmd)
                throws AccessDeniedException,
                       F1Exception

Sets the shape's Z-Order.

Parameters:

eZOrderCmd - the Z-Order.