com.f1j.ss
Class GRObject

java.lang.Object
  |
  +--com.actuate.util.Debug
        |
        +--com.f1j.util.Debug
              |
              +--com.f1j.util.ObjConst
                    |
                    +--com.f1j.util.Obj
                          |
                          +--com.f1j.ss.GRObject

Direct Known Subclasses:

GRChart

Deprecated. Replaced by com.f1j.drawing.Shape.

public class GRObject

extends com.f1j.util.Obj

implements com.f1j.drawing.ShapeConstants, com.f1j.drawing.PropertyConstants

This class provides methods for defining and manipulating graphical objects in the worksheet.

Field Summary

static short	eArc Deprecated. Specifies an arc object.
static short	eArrowFilled Deprecated. Specifies filled arrow style.
static short	eArrowHollow Deprecated. Specifies hollow arrow style.
static short	eArrowLarge Deprecated. Specifies large arrow size.
static short	eArrowMedium Deprecated. Specifies medium arrow size.
static short	eArrowNone Deprecated. Specifies no arrow style.
static short	eArrowSmall Deprecated. Specifies small arrow size.
static short	eButton Deprecated. Specifies a button object.
static short	eCellNone Deprecated. Specifies that the cell value is not changed when selection is made from the drop-down or list box.
static short	eCellText Deprecated. Specifies that the cell value is set to the text of the selection in the drop-down or list box.
static short	eCellValue Deprecated. Specifies that cell value is set to index of selection made from the drop-down list box.
static short	eChart Deprecated. Specifies a chart object.
static short	eCheckBox Deprecated. Specifies a check box object.
static short	eDropDown Deprecated. Specifies a drop down list box object.
static short	eGroup Deprecated. Specifies a group object.
static short	eLine Deprecated. Specifies a line object.
static short	eListBox Deprecated. Specifies a list box object.
static short	eOval Deprecated. Specifies an oval object.
static short	ePicture Deprecated. Specifies a picture object.
static short	ePolygon Deprecated. Specifies a polygon object.
static short	eRadioButton Deprecated. Specifies a radio button object.
static short	eRectangle Deprecated. Specifies a rectangle object.
static short	eText Deprecated. Specifies a text box object.

Method Summary

void	addItem(java.lang.String item) Deprecated.
void	addObject(GRObject obj) Deprecated.
boolean	allowsMultipleSelections() Deprecated.
void	copy(GRObject source) Deprecated.
void	deleteItem(int item) Deprecated.
short	getArrowLength() Deprecated. Replaced by com.f1j.drawing.LineFormat.getEndArrowheadLength().
short	getArrowStyle() Deprecated. Replaced by com.f1j.drawing.LineFormat.getEndArrowheadStyle().
short	getArrowWidth() Deprecated. Replaced by com.f1j.drawing.LineFormat.getEndArrowheadWidth().
java.lang.String	getCell() Deprecated.
int	getCellCol() Deprecated.
int	getCellRow() Deprecated.
short	getCellType() Deprecated.
int	getFontBold() Deprecated. Replaced by com.f1j.paint.FontFormat.isBold().
int	getFontBold(int iStartPos, int iEndPos) Deprecated.
int	getFontColor() Deprecated. Replaced by com.f1j.paint.FontFormat.getColor().
int	getFontColor(int iStartPos, int iEndPos) Deprecated.
int	getFontItalic() Deprecated. Replaced by com.f1j.paint.FontFormat.isItalic().
int	getFontItalic(int iStartPos, int iEndPos) Deprecated.
java.lang.String	getFontName() Deprecated. Replaced by com.f1j.paint.FontFormat.getName().
java.lang.String	getFontName(int iStartPos, int iEndPos) Deprecated.
int	getFontSize() Deprecated. Replaced by com.f1j.paint.FontFormat.getSizeTwips().
int	getFontSize(int iStartPos, int iEndPos) Deprecated.
int	getFontUnderline() Deprecated. Replaced by com.f1j.paint.FontFormat.getUnderline().
int	getFontUnderline(int iStartPos, int iEndPos) Deprecated.
static GRObject	getGRObject(Shape sp) Deprecated.
int	getHorizontalAlignment() Deprecated. Replaced by com.f1j.paint.AlignFormat.getHorizontalAlignment().
int	getID() Deprecated. Replaced by com.f1j.drawing.Shape.getID().
byte[]	getImage() Deprecated.
java.lang.String	getImageFileName() Deprecated.
java.lang.String	getImageURL() Deprecated.
java.lang.String	getItem(int item) Deprecated.
int	getItemCount() Deprecated.
java.lang.String	getItems() Deprecated.
int	getLineColor() Deprecated. Replaced by com.f1j.drawing.LineFormat.getForeColor().
short	getLineStyle() Deprecated. Replaced by com.f1j.drawing.LineFormat.getDashStyle().
int	getLineWeight() Deprecated. Replaced by com.f1j.drawing.LineFormat.getWeight().
java.lang.String	getName() Deprecated. Replaced by com.f1j.drawing.Shape.getName().
GRObject	getNextObject() Deprecated.
short	getPattern() Deprecated. Replaced by com.f1j.drawing.FillFormat.getPattern().
int	getPatternBG() Deprecated. Replaced by com.f1j.drawing.FillFormat.getBackColor().
int	getPatternFG() Deprecated. Replaced by com.f1j.drawing.FillFormat.getForeColor().
java.lang.String	getPatternURL() Deprecated.
GRObjectPos	getPos() Deprecated. Replaced by com.f1j.drawing.Shape.getShapeAnchor().
int	getSelectionCount() Deprecated.
int[]	getSelections() Deprecated.
void	getSelections(int[] iSels) Deprecated.
Shape	getShape() Deprecated. Returns the com.f1j.drawing.Shape associated with this GRObject.
java.lang.String	getText() Deprecated. Replaced by com.f1j.drawing.Shape.getText().
short	getType() Deprecated. Replaced by com.f1j.drawing.Shape.getType() and com.f1j.drawing.Shape.getAutoShapeType().
int	getValue() Deprecated.
int	getVerticalAlignment() Deprecated. Replaced by com.f1j.paint.AlignFormat.getVerticalAlignment().
void	insertItem(int item, java.lang.String itemStr) Deprecated.
boolean	isAutoSize() Deprecated.
boolean	isLineAuto() Deprecated.
boolean	isSelectable() Deprecated. Replaced by com.f1j.drawing.Shape.isAllowSelection().
static boolean	isValidObjectType(short type) Deprecated.
boolean	isVisible() Deprecated.
void	removeAllObjects() Deprecated.
void	setArrowLength(short length) Deprecated. Replaced by com.f1j.drawing.LineFormat.setEndArrowheadLength(com.f1j.drawing.LineFormat.EArrowheadLength).
void	setArrowStyle(short style) Deprecated. Replaced by com.f1j.drawing.LineFormat.setEndArrowheadStyle(com.f1j.drawing.LineFormat.EArrowheadStyle).
void	setArrowWidth(short width) Deprecated. Replaced by com.f1j.drawing.LineFormat.setEndArrowheadWidth(com.f1j.drawing.LineFormat.EArrowheadWidth).
void	setAutoSize(boolean b) Deprecated.
void	setCell(short type, int row, int col) Deprecated.
void	setCell(short type, java.lang.String strCell) Deprecated.
void	setCell(java.lang.String strCell) Deprecated.
void	setCellCol(int col) Deprecated.
void	setCellRow(int row) Deprecated.
void	setCellType(short type) Deprecated.
void	setFontBold(boolean bBold) Deprecated. Replaced by com.f1j.paint.FontFormat.setBold(boolean).
void	setFontBold(boolean bBold, int iStartPos, int iEndPos) Deprecated.
void	setFontColor(int iRGB) Deprecated. Replaced by com.f1j.paint.FontFormat.setColor(int).
void	setFontColor(int iRGB, int iStartPos, int iEndPos) Deprecated.
void	setFontItalic(boolean bItalic) Deprecated. Replaced by com.f1j.paint.FontFormat.setItalic(boolean).
void	setFontItalic(boolean bItalic, int iStartPos, int iEndPos) Deprecated.
void	setFontName(java.lang.String strFontName) Deprecated. Replaced by com.f1j.paint.FontFormat.setName(String).
void	setFontName(java.lang.String strFontName, int iStartPos, int iEndPos) Deprecated.
void	setFontSize(int iSize) Deprecated. Replaced by com.f1j.paint.FontFormat.setSizeTwips(int).
void	setFontSize(int iSize, int iStartPos, int iEndPos) Deprecated.
void	setFontUnderline(boolean bUnderline) Deprecated. Replaced by com.f1j.paint.FontFormat.setUnderline(com.f1j.paint.FontFormat.EUnderline).
void	setFontUnderline(boolean bUnderline, int iStartPos, int iEndPos) Deprecated.
void	setHorizontalAlignment(int iAlign) Deprecated. Replaced by com.f1j.paint.AlignFormat.setHorizontalAlignment(com.f1j.paint.AlignFormat.EHorizontal).
void	setImage(byte[] imageData) Deprecated.
void	setImageFileName(java.lang.String strName) Deprecated.
void	setImageURL(java.lang.String strURL) Deprecated.
void	setItem(int item, java.lang.String itemStr) Deprecated.
void	setItems(java.lang.String items) Deprecated.
void	setLineAuto(boolean bAuto) Deprecated.
void	setLineColor(int iRGB) Deprecated. Replaced by com.f1j.drawing.LineFormat.setForeColor(int).
void	setLineStyle(short style) Deprecated. Replaced by com.f1j.drawing.LineFormat.setDashStyle(com.f1j.drawing.LineFormat.EDashStyle).
void	setLineWeight(int weight) Deprecated. Replaced by com.f1j.drawing.LineFormat.setWeight(double).
void	setMultipleSelections(boolean b) Deprecated.
void	setName(java.lang.String name) Deprecated. Replaced by com.f1j.drawing.Shape.setName(String).
void	setPattern(short pattern) Deprecated. Replaced by com.f1j.drawing.FillFormat.setPattern(com.f1j.paint.FillFormat.EPattern).
void	setPatternBG(int iRGB) Deprecated. Replaced by com.f1j.drawing.FillFormat.setBackColor(int).
void	setPatternFG(int iRGB) Deprecated. Replaced by com.f1j.drawing.FillFormat.setForeColor(int).
void	setPatternURL(java.lang.String strURL) Deprecated.
void	setPoints(java.awt.Point[] points, boolean closed) Deprecated.
void	setPos(double x1, double y1, double x2, double y2) Deprecated. Replaced by com.f1j.ss.ShapeAnchor.setPosition(double, double, double, double).
void	setSelections(int[] iSels) Deprecated.
void	setText(java.lang.String text) Deprecated. Replaced by com.f1j.drawing.Shape.setText(String).
void	setValue(int value) Deprecated.
void	setVerticalAlignment(int iAlign) Deprecated. Replaced by com.f1j.paint.AlignFormat.setVerticalAlignment(com.f1j.paint.AlignFormat.EVertical).
void	setVisible(boolean visible) Deprecated.

Field Detail

eCellNone

public static final short eCellNone

Deprecated.

Specifies that the cell value is not changed when selection is made from the drop-down or list box.

eCellValue

public static final short eCellValue

Deprecated.

Specifies that cell value is set to index of selection made from the drop-down list box.

eCellText

public static final short eCellText

Deprecated.

Specifies that the cell value is set to the text of the selection in the drop-down or list box.

eLine

public static final short eLine

Deprecated.

Specifies a line object.

eRectangle

public static final short eRectangle

Deprecated.

Specifies a rectangle object.

eOval

public static final short eOval

Deprecated.

Specifies an oval object.

eArc

public static final short eArc

Deprecated.

Specifies an arc object.

eChart

public static final short eChart

Deprecated.

Specifies a chart object.

eText

public static final short eText

Deprecated.

Specifies a text box object.

eButton

public static final short eButton

Deprecated.

Specifies a button object.

ePicture

public static final short ePicture

Deprecated.

Specifies a picture object.

ePolygon

public static final short ePolygon

Deprecated.

Specifies a polygon object.

eDropDown

public static final short eDropDown

Deprecated.

Specifies a drop down list box object.

eCheckBox

public static final short eCheckBox

Deprecated.

Specifies a check box object.

eListBox

public static final short eListBox

Deprecated.

Specifies a list box object.

eGroup

public static final short eGroup

Deprecated.

Specifies a group object.

eRadioButton

public static final short eRadioButton

Deprecated.

Specifies a radio button object.

eArrowNone

public static final short eArrowNone

Deprecated.

Specifies no arrow style.

eArrowHollow

public static final short eArrowHollow

Deprecated.

Specifies hollow arrow style.

eArrowFilled

public static final short eArrowFilled

Deprecated.

Specifies filled arrow style.

eArrowSmall

public static final short eArrowSmall

Deprecated.

Specifies small arrow size.

eArrowMedium

public static final short eArrowMedium

Deprecated.

Specifies medium arrow size.

eArrowLarge

public static final short eArrowLarge

Deprecated.

Specifies large arrow size.

Method Detail

addObject

public void addObject(GRObject obj)
               throws F1Exception

Deprecated.

Adds an object to a group object.

The new object is added to the end of the list of groups in the object.

Parameters:

obj - reference to an object to be added to the group

Throws:

F1Exception - if object type is invalid

See Also:

removeAllObjects()

copy

public void copy(GRObject source)
          throws F1Exception

Deprecated.

Copies a source GRObject of the same type.

Parameters:

source - the source GRObject.

Note that this method acquires a lock on both the source and destination GRObject. This method should be used with caution if the source and destination GRObjects are not in the same group.

Throws:

F1Exception - if object type is invalid

removeAllObjects

public void removeAllObjects()
                      throws F1Exception

Deprecated.

Removes all objects from a group object.

All objects in the group will be added to the sheet and the group object will be deleted.

Throws:

F1Exception - if object type is invalid

See Also:

addObject(GRObject obj)

setMultipleSelections

public void setMultipleSelections(boolean b)
                           throws F1Exception

Deprecated.

Sets the multiple selection mode for a list box.

Parameters:

b - a boolean true for multiple selections, false for single selection.

Throws:

F1Exception - if object type is invalid

See Also:

allowsMultipleSelections(), setSelections(int[] iSels), getSelectionCount(), getSelections()

allowsMultipleSelections

public boolean allowsMultipleSelections()
                                 throws F1Exception

Deprecated.

Returns the selection mode of a list box.

Returns:

a boolean true for multiple selection, false for single selection.

Throws:

F1Exception - if object type is invalid

See Also:

setMultipleSelections(boolean b)

setSelections

public void setSelections(int[] iSels)
                   throws F1Exception

Deprecated.

Sets the selected items in a list box.

Parameters:

iSels - an int[] of indices. 0-based.

Throws:

F1Exception - if object type is invalid

See Also:

setMultipleSelections(boolean b), getSelectionCount(), getSelections()

getSelectionCount

public int getSelectionCount()
                      throws F1Exception

Deprecated.

Returns the number of selected items in a list box.

Returns:

an int indicating # of items.

Throws:

F1Exception - if object type is invalid

See Also:

setMultipleSelections(boolean b), setSelections(int[] iSels), getSelections()

getSelections

public int[] getSelections()
                    throws F1Exception

Deprecated.

Returns the selected indices.

Returns:

an int[] of indices. 0-based.

Throws:

F1Exception - if object type is invalid

See Also:

setMultipleSelections(boolean b), setSelections(int[] iSels), getSelectionCount()

getSelections

public void getSelections(int[] iSels)
                   throws F1Exception

Deprecated.

Returns the selected indices.

Parameters:

iSels - an int[] of indices. 0-based.

Throws:

F1Exception - if object type is invalid or if the int[] param is invalid

See Also:

setMultipleSelections(boolean b), setSelections(int[] iSels), getSelectionCount(), getSelections()

addItem

public void addItem(java.lang.String item)
             throws F1Exception

Deprecated.

Adds an item to a drop down or list box object.

The new item is added to the end of the list of items in the object.

Parameters:

item - reference to a string to be added to the drop down or list box object

Throws:

F1Exception - if object type is invalid

See Also:

insertItem(int, String), deleteItem(int)

deleteItem

public void deleteItem(int item)
                throws F1Exception

Deprecated.

Deletes an item from a drop down or list box object.

Parameters:

item - Number of the item to delete.

Items in a list are numbered sequentially starting with 0.

Throws:

F1Exception - if object type is invalid

See Also:

addItem(String), getValue()

getArrowLength

public short getArrowLength()
                     throws F1Exception

Deprecated. Replaced by com.f1j.drawing.LineFormat.getEndArrowheadLength().

Returns the length of the arrow.

Returns:

the length of the arrow.

Throws:

F1Exception - if object type is invalid

See Also:

setArrowLength(short)

getArrowStyle

public short getArrowStyle()
                    throws F1Exception

Deprecated. Replaced by com.f1j.drawing.LineFormat.getEndArrowheadStyle().

Returns the style of the arrow.

Returns:

the number identifying one of the following arrow styles:

   eArrowNone
   eArrowHollow
   eArrowFilled

Throws:

F1Exception - if object type is invalid

See Also:

setArrowStyle(short)

getArrowWidth

public short getArrowWidth()
                    throws F1Exception

Deprecated. Replaced by com.f1j.drawing.LineFormat.getEndArrowheadWidth().

Returns the width of the arrow.

Returns:

number identifying one of the following arrow widths:

   eArrowSmall
   eArrowMedium
   eArrowLarge

Throws:

F1Exception - if object type is invalid

See Also:

setArrowWidth(short)

getCell

public java.lang.String getCell()
                         throws F1Exception

Deprecated.

Returns the cell specified check box, drop down or list box object is linked.

Returns:

a range string representing the cell that is linked.

Throws:

F1Exception - if object type is invalid

See Also:

setCell(String)

getCellCol

public int getCellCol()
               throws F1Exception

Deprecated.

Returns the number of the cell column to which specified check box, drop down or list box object is linked.

Returns:

the number of the cell column.

Throws:

F1Exception - if object type is invalid

See Also:

setCellCol(int)

getCellRow

public int getCellRow()
               throws F1Exception

Deprecated.

Returns the number of the cell row to which the specified check box, drop down or list box object is linked.

Returns:

the number of the cell row.

Throws:

F1Exception - if object type is invalid

See Also:

setCellRow(int)

getCellType

public short getCellType()
                  throws F1Exception

Deprecated.

Returns the cell behavior for the specified check box, drop down, radio button, or list box object.

Returns:

the cell behavior.

Throws:

F1Exception - if object type is invalid

See Also:

setCellType(short)

getFontBold

public int getFontBold()
                throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.isBold().

Returns if the font is bold in a TextArea.

Returns:

0 if NOT bold, 1 if bold, or -1 if undefined.

Throws:

F1Exception - if object type is invalid

See Also:

getFontBold(int, int), setFontBold(boolean), setFontBold(boolean, int, int)

getFontBold

public int getFontBold(int iStartPos,
                       int iEndPos)
                throws F1Exception

Deprecated.

Returns if the font is bold in a TextArea.

Parameters:

iStartPos - starting position in the text (0 based).

iEndPos - ending position in the text (0 based).

Returns:

0 if NOT bold, 1 if bold, or -1 if undefined.

Throws:

F1Exception - if object type is invalid or positions are not valid

See Also:

getFontBold(), setFontBold(boolean), setFontBold(boolean, int, int)

getFontColor

public int getFontColor()
                 throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.getColor().

Returns the font color in a TextArea.

Returns:

font color

Throws:

F1Exception - if object type is invalid

See Also:

getFontColor(int, int), setFontColor(int), setFontColor(int, int, int)

getFontColor

public int getFontColor(int iStartPos,
                        int iEndPos)
                 throws F1Exception

Deprecated.

Returns the font color in a TextArea.

Parameters:

iStartPos - starting position in the text (0 based).

iEndPos - ending position in the text (0 based).

Returns:

font size in TWIPS (1/20 of a point), or -1 if undefined.

Throws:

F1Exception - if object type is invalid or positions are not valid

See Also:

getFontColor(), setFontColor(int), setFontColor(int, int, int)

getFontItalic

public int getFontItalic()
                  throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.isItalic().

Returns if the font is italic in a TextArea.

Returns:

0 if NOT italic, 1 if italic, or -1 if undefined.

Throws:

F1Exception - if object type is invalid.

See Also:

getFontItalic(int, int), setFontItalic(boolean), setFontItalic(boolean, int, int)

getFontItalic

public int getFontItalic(int iStartPos,
                         int iEndPos)
                  throws F1Exception

Deprecated.

Returns if the font is italic in a TextArea.

Parameters:

iStartPos - starting position in the text (0 based).

iEndPos - ending position in the text (0 based).

Returns:

0 if NOT italic, 1 if italic, or -1 if undefined.

Throws:

F1Exception - if object type is invalid or positions are not valid

See Also:

getFontItalic(), setFontItalic(boolean), setFontItalic(boolean, int, int)

getFontName

public java.lang.String getFontName()
                             throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.getName().

Returns the font name in a TextArea.

Returns:

the font name or NULL if undefined.

Throws:

F1Exception - if object type is invalid.

See Also:

getFontName(int, int), setFontName(String), setFontName(String, int, int)

getFontName

public java.lang.String getFontName(int iStartPos,
                                    int iEndPos)
                             throws F1Exception

Deprecated.

Returns the font name in a TextArea.

Parameters:

iStartPos - starting position in the text (0 based).

iEndPos - ending position in the text (0 based).

Returns:

the font name or NULL if undefined.

Throws:

F1Exception - if object type is invalid or positions are not valid

See Also:

getFontName(int, int), setFontName(String), setFontName(String, int, int)

getFontSize

public int getFontSize()
                throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.getSizeTwips().

Returns the font size in a TextArea.

Returns:

font size in TWIPS (1/20 of a point), or -1 if undefined.

Throws:

F1Exception - if object type is invalid.

See Also:

getFontSize(int, int), setFontSize(int), setFontSize(int, int, int)

getFontSize

public int getFontSize(int iStartPos,
                       int iEndPos)
                throws F1Exception

Deprecated.

Returns the font size in a TextArea.

Parameters:

iStartPos - starting position in the text (0 based).

iEndPos - ending position in the text (0 based).

Returns:

font size in TWIPS (1/20 of a point), or -1 if undefined.

Throws:

F1Exception - if object type is invalid or positions are not valid

See Also:

getFontSize(), setFontSize(int), setFontSize(int, int, int)

getFontUnderline

public int getFontUnderline()
                     throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.getUnderline().

Returns an integer indicating whether the font is underlined in a TextArea.

Returns:

0 if NOT underlined, 1 if underlined, or -1 if undefined

Throws:

F1Exception - if object type is invalid

See Also:

getFontUnderline(int, int), setFontUnderline(boolean), setFontUnderline(boolean, int, int)

getFontUnderline

public int getFontUnderline(int iStartPos,
                            int iEndPos)
                     throws F1Exception

Deprecated.

Returns an integer indicating whether the font is underlined in a TextArea.

Parameters:

iStartPos - starting position in the text (0 based)

iEndPos - ending position in the text (0 based)

Returns:

0 if NOT underlined, 1 if underlined, or -1 if undefined

Throws:

F1Exception - if object type is invalid or positions are not valid

See Also:

getFontUnderline(int, int), setFontUnderline(boolean), setFontUnderline(boolean, int, int)

getGRObject

public static GRObject getGRObject(Shape sp)

Deprecated.

Returns a GRObject associated with the com.f1j.drawing.Shape.

Parameters:

sp - com.f1j.drawing.Shape

Returns:

an instance of the GRObject object.

See Also:

getShape()

getHorizontalAlignment

public int getHorizontalAlignment()
                           throws F1Exception

Deprecated. Replaced by com.f1j.paint.AlignFormat.getHorizontalAlignment().

Returns the horizontal alignment of a TextArea.

Returns:

one of the following alignment types:

1 - left 2 - center 3 - right 4 - justify

Throws:

F1Exception - if object type is invalid

See Also:

setHorizontalAlignment(int)

getID

public int getID()

Deprecated. Replaced by com.f1j.drawing.Shape.getID().

Returns the number identifying the first object in the active worksheet.

Returns:

the number identifying the first object

getImage

public byte[] getImage()
                throws F1Exception

Deprecated.

Returns the bytes identifying an image associated with a picture object.

Returns:

the bytes for the image or null if there is none.

Throws:

F1Exception - if object type is invalid.

See Also:

setImage(byte[])

getImageFileName

public java.lang.String getImageFileName()
                                  throws F1Exception

Deprecated.

Returns the file name string identifying an image associated with a picture object.

Returns:

the file name for the image or null if there is none.

Throws:

F1Exception - if object type is invalid

See Also:

setImageFileName(String)

getImageURL

public java.lang.String getImageURL()
                             throws F1Exception

Deprecated.

Returns the url string identifying an image associated with a picture object.

Returns:

the URL for the image or null if there is none.

Throws:

F1Exception - if object type is invalid

See Also:

setImageURL(String)

getItem

public java.lang.String getItem(int item)
                         throws F1Exception

Deprecated.

Returns an item from a drop down or list box object.

Parameters:

item - identifies the item in the list. Items are numbered sequentially starting with 0.

Returns:

a string identifying the item.

Throws:

F1Exception - if object type is invalid

See Also:

setItem(int,String)

getItemCount

public int getItemCount()
                 throws F1Exception

Deprecated.

Returns the number of items in a drop down or list box object.

Returns:

the number of items.

Throws:

F1Exception - if object type is invalid

getItems

public java.lang.String getItems()
                          throws F1Exception

Deprecated.

Returns the list of items contained in a drop down or list box.

Returns:

a semicolon-delimited list of items.

Throws:

F1Exception - if object type is invalid

See Also:

setItems(String)

getLineColor

public int getLineColor()
                 throws F1Exception

Deprecated. Replaced by com.f1j.drawing.LineFormat.getForeColor().

Returns the color for the selected line object.

Returns:

the color for the line object.

Throws:

F1Exception - if object type is invalid

See Also:

setLineColor(int)

getLineStyle

public short getLineStyle()
                   throws F1Exception

Deprecated. Replaced by com.f1j.drawing.LineFormat.getDashStyle().

Returns the style for the selected line object.

Returns:

the line style

Throws:

F1Exception - if object type is invalid

See Also:

setLineStyle(short)

getLineWeight

public int getLineWeight()
                  throws F1Exception

Deprecated. Replaced by com.f1j.drawing.LineFormat.getWeight().

Returns the weight of the selected line object.

Returns:

the line weight.

Throws:

F1Exception - if object type is invalid

See Also:

setLineWeight(int)

isAutoSize

public boolean isAutoSize()
                   throws F1Exception

Deprecated.

Returns if image is auto sized.

Returns:

true if autosizing is turn on, otherwise false.

Throws:

F1Exception - if object type is invalid

See Also:

setAutoSize(boolean b)

isLineAuto

public boolean isLineAuto()
                   throws F1Exception

Deprecated.

Returns if the line is automatic.

Returns:

true if line is automatic otherwise false.

Throws:

F1Exception - if object type is invalid

See Also:

setLineAuto(boolean)

isSelectable

public boolean isSelectable()

Deprecated. Replaced by com.f1j.drawing.Shape.isAllowSelection().

Returns if the object is selectable.

Returns:

true if object is selectable, otherwise false.

getName

public java.lang.String getName()

Deprecated. Replaced by com.f1j.drawing.Shape.getName().

Returns the name of the specified object.

Returns:

the object name.

See Also:

setName(String)

getNextObject

public GRObject getNextObject()

Deprecated.

This routine is used to enumerate through the objects on the worksheet.

Returns:

GRObject the next object in the list.

getPattern

public short getPattern()
                 throws F1Exception

Deprecated. Replaced by com.f1j.drawing.FillFormat.getPattern().

Returns the pattern style for the currently selected object.

Returns:

the pattern number used to display the object.

Throws:

F1Exception - if object type is invalid

See Also:

setPattern(short)

getPatternBG

public int getPatternBG()
                 throws F1Exception

Deprecated. Replaced by com.f1j.drawing.FillFormat.getBackColor().

Returns the pattern background color.

Returns:

the pattern background color.

Throws:

F1Exception - if object type is invalid

See Also:

setPatternBG(int)

getPatternFG

public int getPatternFG()
                 throws F1Exception

Deprecated. Replaced by com.f1j.drawing.FillFormat.getForeColor().

Returns the pattern foreground color.

Returns:

the pattern foreground color.

Throws:

F1Exception - if object type is invalid

See Also:

setPatternFG(int)

getPatternURL

public java.lang.String getPatternURL()
                               throws F1Exception

Deprecated.

Returns the pattern URL.

Returns:

the pattern URL.

Throws:

F1Exception - if object type is invalid

See Also:

setPatternURL(String)

getPos

public GRObjectPos getPos()

Deprecated. Replaced by com.f1j.drawing.Shape.getShapeAnchor().

Returns the position of the object.

Returns:

an instance of the GRObjPos object.

See Also:

setPos(double, double, double, double)

getShape

public Shape getShape()

Deprecated.

Returns the com.f1j.drawing.Shape associated with this GRObject.

Returns:

an instance of the com.f1j.drawing.Shape object.

See Also:

getGRObject(com.f1j.drawing.Shape sp)

getText

public java.lang.String getText()
                         throws F1Exception

Deprecated. Replaced by com.f1j.drawing.Shape.getText().

Returns the text displayed on a check box, button, or text area.

Returns:

the string containing the text displayed on a check box, button, or text area.

Throws:

F1Exception - if object type is invalid

See Also:

setText(String)

getType

public short getType()

Deprecated. Replaced by com.f1j.drawing.Shape.getType() and com.f1j.drawing.Shape.getAutoShapeType().

Returns the object type of the specified object.

Returns:

one of the following object types:

eLine eRectangle eOval eArc eButton ePicture ePolygon eDropDown eCheckBox eListBox eGroup eRadioButton eText

getValue

public int getValue()
             throws F1Exception

Deprecated.

Returns the current selection value in a specified check box, drop down or list box.

Returns:

the value of the current selection.

Throws:

F1Exception - if object type is invalid

See Also:

setValue(int)

getVerticalAlignment

public int getVerticalAlignment()
                         throws F1Exception

Deprecated. Replaced by com.f1j.paint.AlignFormat.getVerticalAlignment().

Returns the vertical alignment of a TextArea.

Returns:

one of the following alignment types:

1 - top 2 - center 3 - bottom 4 - Justify

Throws:

F1Exception - if object type is invalid

See Also:

setVerticalAlignment(int)

insertItem

public void insertItem(int item,
                       java.lang.String itemStr)
                throws F1Exception

Deprecated.

Inserts an item at a specific location in a list of items for a drop down or list box.

Parameters:

item - Number of the item before which the new item is inserted.

Items are numbered sequentially starting with 0.

itemStr - Reference to the item to be inserted.

Throws:

F1Exception - if object type is invalid

See Also:

addItem(String)

isValidObjectType

public static boolean isValidObjectType(short type)

Deprecated.

Checks for a valid object type. Returns true if the object is valid, even if the object type is no longer supported.

Parameters:

type - the type to check.

Returns:

true if type is a valid object type.

isVisible

public boolean isVisible()

Deprecated.

Returns true if an object is visible.

Returns:

true if object is visible, false otherwise.

See Also:

setVisible(boolean)

setArrowLength

public void setArrowLength(short length)
                    throws F1Exception

Deprecated. Replaced by com.f1j.drawing.LineFormat.setEndArrowheadLength(com.f1j.drawing.LineFormat.EArrowheadLength).

Sets the length of the arrow.

Parameters:

length - the length of the arrow

Throws:

F1Exception - if object type is invalid or parameter is invalid.

See Also:

getArrowLength()

setArrowStyle

public void setArrowStyle(short style)
                   throws F1Exception

Deprecated. Replaced by com.f1j.drawing.LineFormat.setEndArrowheadStyle(com.f1j.drawing.LineFormat.EArrowheadStyle).

Sets the style of the arrow.

Parameters:

style - number identifying one of the following arrow styles:

   eArrowNone
   eArrowHollow
   eArrowFilled

Throws:

F1Exception - if object type is invalid or parameter is invalid

See Also:

getArrowStyle()

setArrowWidth

public void setArrowWidth(short width)
                   throws F1Exception

Deprecated. Replaced by com.f1j.drawing.LineFormat.setEndArrowheadWidth(com.f1j.drawing.LineFormat.EArrowheadWidth).

Sets the width of the arrow.

Parameters:

width - one of the following arrow widths:

   eArrowSmall
   eArrowMedium
   eArrowLarge

Throws:

F1Exception - if object type is invalid or parameter is invalid

See Also:

getArrowWidth()

setAutoSize

public void setAutoSize(boolean b)
                 throws F1Exception

Deprecated.

Sets the selected image object to have automatic size or not.

Parameters:

b - true if automatic sizing is turned on otherwise false.

Throws:

F1Exception - if object type is invalid

See Also:

isAutoSize()

setCell

public void setCell(short type,
                    int row,
                    int col)
             throws F1Exception

Deprecated.

Assigns a worksheet cell to hold the value displayed by the specified check box, drop down, list box, radio button, or radio button group object.

Parameters:

type - Sets the object cell flag. This flag controls what is placed in the cell identified by row and column when a selection is made from the check box, drop down or list box. Following are the valid flags:

eCell	- cell value is not changed when selection is made from drop down or list box.
eCellValue	- cell value is set to index of selection in drop down or list box.
eCellText	- cell value is set to text of selection in dropdown

row - Number of the row in which the object value is placed.

col - Number of the column in which the object value is placed.

Throws:

F1Exception - if object type is invalid or parameter is invalid

setCell

public void setCell(java.lang.String strCell)
             throws F1Exception

Deprecated.

To link a check box, drop down or list box object to a cell, setCellRange specifies the range of the linked cell.

Parameters:

strCell - the range of the cell (can use defined names)

Throws:

F1Exception - if object type is invalid or parameter is invalid

See Also:

getCell()

setCell

public void setCell(short type,
                    java.lang.String strCell)
             throws F1Exception

Deprecated.

Assigns a worksheet cell to hold the value displayed by the specified check box, drop down, list box, radio button, or radio button group object.

Parameters:

type - Sets the object cell flag. This flag controls what is placed in the cell identified by row and column when a selection is made from the check box, drop down or list box. Following are the valid flags:

eCell	- cell value is not changed when selection is made from drop down or list box.
eCellValue	- cell value is set to index of selection in drop down or list box.
eCellText	- cell value is set to text of selection in dropdown

strCell - the range of the cell (can use defined names)

Throws:

F1Exception - if object type is invalid or parameter is invalid

See Also:

getCell()

setCellCol

public void setCellCol(int col)
                throws F1Exception

Deprecated.

To link a check box, drop down or list box object to a cell, setCellCol specifies the column coordinate of the linked cell.

Parameters:

col - the number of the cell column.

Throws:

F1Exception - if object type is invalid or parameter is invalid

See Also:

getCellCol()

setCellRow

public void setCellRow(int row)
                throws F1Exception

Deprecated.

To link a check box, drop down or list box object to a cell, setCellRow specifies the row coordinate of the linked cell.

Parameters:

row - the number of the cell row

Throws:

F1Exception - if object type is invalid or parameter is invalid

See Also:

getCellRow()

setCellType

public void setCellType(short type)
                 throws F1Exception

Deprecated.

Sets the cell behavior for the specified check box, drop down, radio button or list box object.

Parameters:

type - the cell behavior. eNone Cell value is not changed when selection is made. eCellValue Cell value is set to index of selection. eCellText Cell value is set to text of selection.

Throws:

F1Exception - if object type is invalid or parameter is invalid

See Also:

getCellType()

setFontBold

public void setFontBold(boolean bBold)
                 throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.setBold(boolean).

Sets the font bold attribute.

Parameters:

bBold - true if bold, otherwise false.

Throws:

F1Exception - if object type is invalid.

See Also:

setFontBold(boolean, int, int), getFontBold(), getFontBold(int, int)

setFontBold

public void setFontBold(boolean bBold,
                        int iStartPos,
                        int iEndPos)
                 throws F1Exception

Deprecated.

Sets the font bold attribute.

Parameters:

bBold - true if bold, otherwise false.

iStartPos - starting position in the text (0 based).

iEndPos - ending position in the text (0 based).

Throws:

F1Exception - if object type is invalid or positions are invalid

See Also:

setFontBold(boolean), getFontBold(), getFontBold(int, int)

setFontColor

public void setFontColor(int iRGB)
                  throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.setColor(int).

Sets the font color in a TextArea.

Parameters:

iRGB - font color.

Throws:

F1Exception - if object type is invalid

See Also:

setFontColor(int, int, int), getFontColor(), getFontColor(int, int)

setFontColor

public void setFontColor(int iRGB,
                         int iStartPos,
                         int iEndPos)
                  throws F1Exception

Deprecated.

Sets the font color in a TextArea.

Parameters:

iRGB - font color.

iStartPos - starting position in the text (0 based).

iEndPos - ending position in the text (0 based).

Throws:

F1Exception - if object type is invalid or positions are not valid

See Also:

setFontColor(int, int, int), getFontColor(), getFontColor(int, int)

setFontItalic

public void setFontItalic(boolean bItalic)
                   throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.setItalic(boolean).

Sets the font italic attribute.

Parameters:

bItalic - true if italic otherwise false.

Throws:

F1Exception - if object type is invalid.

See Also:

setFontItalic(boolean, int, int), getFontItalic(), getFontItalic(int, int)

setFontItalic

public void setFontItalic(boolean bItalic,
                          int iStartPos,
                          int iEndPos)
                   throws F1Exception

Deprecated.

Sets the font italic attribute.

Parameters:

bItalic - true if italic otherwise false.

iStartPos - starting position in the text (0 based).

iEndPos - ending position in the text (0 based).

Throws:

F1Exception - if object type is invalid or positions are invalid

See Also:

setFontItalic(boolean), getFontItalic(), getFontItalic(int, int)

setFontName

public void setFontName(java.lang.String strFontName)
                 throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.setName(String).

Sets the font italic attribute.

Parameters:

strFontName - name of font.

Throws:

F1Exception - if object type is invalid.

See Also:

setFontName(String, int, int), getFontName(), getFontName(int, int)

setFontName

public void setFontName(java.lang.String strFontName,
                        int iStartPos,
                        int iEndPos)
                 throws F1Exception

Deprecated.

Sets the font italic attribute.

Parameters:

strFontName - name of font.

iStartPos - starting position in the text (0 based).

iEndPos - ending position in the text (0 based).

Throws:

F1Exception - if object type is invalid or positions are invalid

See Also:

setFontName(String), getFontName(), getFontName(int, int)

setFontSize

public void setFontSize(int iSize)
                 throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.setSizeTwips(int).

Sets the font size in TWIPS (1/20th of a point).

Parameters:

iSize - size of font.

Throws:

F1Exception - if object type is invalid

See Also:

setFontSize(int, int, int), getFontSize(), getFontSize(int, int)

setFontSize

public void setFontSize(int iSize,
                        int iStartPos,
                        int iEndPos)
                 throws F1Exception

Deprecated.

Sets the font size in TWIPS (1/20th of a point).

Parameters:

iSize - size of font.

iStartPos - starting position in the text (0 based).

iEndPos - ending position in the text (0 based).

Throws:

F1Exception - if object type is invalid or positions are invalid

See Also:

setFontSize(int), getFontSize(), getFontSize(int, int)

setFontUnderline

public void setFontUnderline(boolean bUnderline)
                      throws F1Exception

Deprecated. Replaced by com.f1j.paint.FontFormat.setUnderline(com.f1j.paint.FontFormat.EUnderline).

Sets the font underline attribute.

Parameters:

bUnderline - true if bold, otherwise false.

Throws: