Class Sheet
This concrete class represents a drawing sheet in a design.
public class Sheet
extends PropertySet
Hierarchical Diagram
Direct Known Subclasses
None
Constructor
public Sheet()
Methods
• getName
Returns the name of the sheet.
public String getName()
Throws: RSDException
• open
Opens the sheet.
public void open()
Throws: RSDException
• close
Closes the currently open sheet.
public void close()
Throws: RSDException
• getShapes
Returns an iterator of all the shapes on the sheet. Each element in the iterator is a one-element array that contains shape related information.
public Iterator getShapes()
Throws: RSDException
• getShapes
Returns an iterator of all the shapes on the sheet that belong to the specified classes. Each element in the iterator is a one-element array that contains shape related information.
public Iterator getShapes(boolean onlyRootShapes, String[] classNames)
Where:
onlyRootShapes—If true, then the getShapes function returns only top level shapes that belong to the specified classes.
classNames—A list of specified classes.
Throws: RSDException
• getShapesVector
Returns a vector of all the shapes on the sheet.
public Vector getShapesVector()
Throws: RSDException
• getShapesVector
Returns a vector of all the shapes on the sheet that belong to the specified classes.
public Vector getShapesVector(boolean onlyRootShapes, String[] classNames)
Where:
onlyRootShapes—If true, then the getShapes function returns only top level shapes that belong to the specified classes.
classNames—A list of specified classes.
Throws: RSDException
• getBlockShapes
Returns an iterator of all the blockshapes on the sheet. Each element in the iterator is a one-element array that contains blockshape related information.
public Iterator getBlockShapes()
Throws: RSDException
• getBlockShapesVector
Returns a vector of all the blockshapes on the sheet.
public Vector getBlockShapesVector()
Throws: RSDException
• getFibreShapes
Returns an iterator of all the fibershapes on the sheet. Each element in the iterator is a one-element array that contains fibreshape related information.
public Iterator getFibreShapes()
Throws: RSDException
• getFibreShapesVector
Returns a vector of all the fibershapes on the sheet.
public Vector getFibreShapeVector()
Throws: RSDException
• getGroupShapes
Returns an iterator of all the groupshapes on the sheet. Each element in the iterator is a one-element array that contains groupshape related information.
public Iterator getGroupShapes()
Throws: RSDException
• getGroupShapesVector
Returns a vector of all the groupshapes on the sheet.
public Vector getGroupShapesVector()
Throws: RSDException
• getPortShapes
Returns an iterator of all the portshapes on the sheet. Each element in the iterator is a one-element array that contains portshape related information.
public Iterator getPortShapes()
Throws: RSDException
• getPortShapesVector
Returns a vector of all the portshapes on the sheet.
public Vector getPortShapesVector()
Throws: RSDException
• getBlocks
Returns an iterator of all the blocks that have one or more shapes on the sheet. Each element in the iterator is a one-element array that contains block related information.
public Iterator getBlocks()
Throws: RSDException
• getBlocksVector
Returns a vector of all the blocks that have one or more shapes on the sheet.
public Vector getBlocksVector()
Throws: RSDException
• getFibres
Returns an iterator of all the fibers that have one or more shapes on the sheet. Each element in the iterator is a one-element array that contains fibre related information.
public Iterator getFibres()
Throws: RSDException
• getFibresVector
Returns a vector of all the fibers that have one or more shapes on the sheet.
public Vector getFibresVector()
Throws: RSDException
• getGroups
Returns an iterator of all the groups that have one or more shapes on the sheet. Each element in the iterator is a one-element array that contains group related information.
public Iterator getGroups()
Throws: RSDException
• getGroupsVector
Returns a vector of all the groups that have one or more shapes on the sheet.
public Vector getGroupsVector()
Throws: RSDException
• getPorts
Returns an iterator of all the ports that have one or more shapes on the sheet. Each element in the iterator is a one-element array that contains port related information.
public Iterator getPorts()
Throws: RSDException
• getPortsVector
Returns a vector of all the ports that have one or more shapes on the sheet.
public Vector getPortsVector()
Throws: RSDException
• isDesignSheet
Returns whether the sheet is a design sheet or not.
public boolean isDesignSheet()
Throws: RSDException
• getCurrentSheet
Returns the currently displayed sheet.
public static Sheet getCurrentSheet()
Throws: RSDException
• isOpenSheet
Returns true if the sheet is open.
public boolean isOpenSheet()
Throws: RSDException
• CreateCrossoversOnSheet
Creates crossovers on the sheet.
public void CreateCrossoversOnSheet()
Throws: RSDException
• DeleteCrossoversOnSheet
Deletes the crossovers on the sheet.
public void DeleteCrossoversOnSheet()
Throws: RSDException
• getLocationset
Returns the location set to which the sheet belongs and the sequence number of the sheet in the location set.
public Object[] getLocationset()
Throws: RSDException
• getRowCoulmnInfo
Returns the location set to which the sheet belongs to in terms of rows and columns.
The location set is an object array of three elements. Each element is a sub-array of three elements.
The first element is a sub-array of three elements—column number, X position of the sheet, and the width of the sheet along the x-axis.
The second element is a sub-array of three elements—row number, Y position of the sheet, and the width of the sheet along the y-axis.
The third element is a sub-array of four elements—first two elements of the X and Y coordinates of the start datum of the sheet and the last two elements of the X and Y coordinates of the end datum of the sheet.
public Object[] getRowColumnInfo()
Throws: RSDException
Methods Inherited
The methods inherited from other classes are:
Class | Methods Inherited |
rsdesigner.design.PropertySet | getIntegerProperty, getProperties, getProperty, getRealProperty, getStringProperty, getType |
java.lang.Object | equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
