|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IRPStatechart
The IRPStatechart interface represents the statechart elements underlying a statechart. The statechart itself is represented by the IRPStatechartDiagram interface. You can create an IRPStatechart object with the method IRPClass.addStatechart().
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface com.telelogic.rhapsody.core.IRPModelElement |
---|
IRPModelElement.OSLCLink |
Method Summary | |
---|---|
IRPGraphElement |
addFreeShapeByType(java.lang.String metaType,
IRPCollection xPoints,
IRPCollection yPoints)
Adds a free shape of the type specified, using the x coordinates and y coordinates provided. |
IRPGraphElement |
addImage(java.lang.String filename,
int xPosition,
int yPosition,
int nWidth,
int nHeight)
Adds an image to the statechart, using the specified file, starting point, width, and height. |
IRPGraphEdge |
addNewEdgeByType(java.lang.String metaType,
IRPGraphElement src,
int xSrcPosition,
int ySrcPosition,
IRPGraphElement trg,
int xTrgPosition,
int yTrgPosition)
Adds a connector element of the specified type to the statechart, using the source and target elements specified. |
IRPGraphEdge |
addNewEdgeForElement(IRPModelElement element,
IRPGraphNode src,
int xSrcPosition,
int ySrcPosition,
IRPGraphNode trg,
int xTrgPosition,
int yTrgPosition)
Adds a connector graphical element to the statechart to represent the specified model element. |
IRPGraphNode |
addNewNodeByType(java.lang.String metaType,
int xPosition,
int yPosition,
int nWidth,
int nHeight)
Adds a statechart element of the specified type to the statechart, using the position and dimensions specified. |
IRPGraphNode |
addNewNodeForElement(IRPModelElement element,
int xPosition,
int yPosition,
int nWidth,
int nHeight)
Adds a graphical element to the statechart to represent the specified model element. |
IRPGraphElement |
addTextBox(java.lang.String text,
int xPosition,
int yPosition,
int nWidth,
int nHeight)
Adds a text box using the specified text, starting point, width, and height. |
void |
closeDiagram()
Closes the statechart. |
void |
createGraphics()
Creates the graphical representation of the elements in the statechart. |
void |
deleteState(IRPState state)
Deletes the specified state from the statechart. |
int |
findTrigger(IRPInterfaceItem Item)
Checks whether the specified IRPInterfaceItem element serves as the trigger of a transition in the statechart. |
IRPCollection |
getAllTriggers()
Returns a collection of all the triggers in the statechart |
IRPCollection |
getElementsInDiagram()
Returns a collection of all of the elements in the statechart. |
IRPCollection |
getGraphicalElements()
Returns a collection of all the graphical elements in the statechart. |
IRPStatechart |
getInheritsFrom()
Returns the statechart of the base class of this class. |
int |
getIsMainBehavior()
Checks whether the statechart is the main behavior for the class. |
int |
getIsOverridden()
Checks whether the inheritance relationship between this statechart and the statechart of the base class was overridden. |
IRPClassifier |
getItsClass()
Returns the class that the statechart is associated with. |
void |
getPicture(java.lang.String filename)
Saves the statechart as an emf format file, using the path and filename provided as a parameter. |
IRPCollection |
getPictureAs(java.lang.String firstFileName,
java.lang.String imageFormat,
int getImageMaps,
IRPCollection diagrammap)
Saves the statechart in the specified graphic format, breaking the diagram into a number of files if necessary. |
IRPCollection |
getPictureAsDividedMetafiles(java.lang.String firstFileName)
Saves the statechart as an emf format file, breaking the diagram into a number of such files if necessary. |
IRPCollection |
getPicturesWithImageMap(java.lang.String firstFileName,
IRPCollection diagrammap)
Saves the statechart as an emf format file, breaking the diagram into a number of files if necessary. |
IRPState |
getRootState()
Returns the root state of the statechart. |
IRPStatechartDiagram |
getStatechartDiagram()
Returns the IRPStatechartDiagram object associated with the statechart. |
IRPAXViewCtrl |
openDiagramView()
Used internally by Rational Rhapsody to display diagrams within Eclipse (when using the Rhapsody-Eclipse platform integration). |
void |
overrideInheritance()
Breaks the inheritance relationship between this statechart and the statechart of the base class. |
void |
populateDiagram(IRPCollection elementsToPopulate,
IRPCollection relationsTypes,
java.lang.String createContent)
Populates the statechart with the elements and types of relations specified. |
void |
setAsMainBehavior()
Specifies that this statechart should be the main behavior for the class. |
void |
setShowDiagramFrame(int bShow)
Shows/hides the diagram frame. |
void |
unoverrideInheritance()
Restores the inheritance relationship between this statechart and the statechart of the base class. |
Methods inherited from interface com.telelogic.rhapsody.core.IRPClass |
---|
addClass, addConstructor, addDestructor, addEventReception, addLink, addLinkToPartViaPort, addReception, addSuperclass, addTriggeredOperation, addType, deleteClass, deleteConstructor, deleteDestructor, deleteEventReception, deleteReception, deleteSuperclass, deleteType, getIsAbstract, getIsActive, getIsBehaviorOverriden, getIsComposite, getIsFinal, getIsReactive, setIsAbstract, setIsActive, setIsBehaviorOverriden, setIsFinal |
Methods inherited from interface com.telelogic.rhapsody.core.IRPUnit |
---|
copyToAnotherProject, getAddToModelMode, getCMHeader, getCMState, getCurrentDirectory, getFilename, getIncludeInNextLoad, getIsStub, getLanguage, getLastModifiedTime, getNestedSaveUnits, getNestedSaveUnitsCount, getStructureDiagrams, isReadOnly, isReferenceUnit, isSeparateSaveUnit, load, moveToAnotherProjectLeaveAReference, referenceToAnotherProject, save, setCMHeader, setFilename, setIncludeInNextLoad, setLanguage, setReadOnly, setSeparateSaveUnit, setUnitPath, unload |
Method Detail |
---|
IRPGraphElement addFreeShapeByType(java.lang.String metaType, IRPCollection xPoints, IRPCollection yPoints)
metaType
- the type of shape to add. The possible values for this parameter are: "Polyline", "Polygon", "Rectangle", "Polycurve", "Closed Curve", "Ellipse".xPoints
- collection of integers representing the x coordinates for the shapeyPoints
- collection of integers representing the y coordinates for the shape
IRPGraphElement addImage(java.lang.String filename, int xPosition, int yPosition, int nWidth, int nHeight)
filename
- the full path to the imagexPosition
- the x coordinate for the top left corner of the image, in pixelsyPosition
- the y coordinate for the top left corner of the image, in pixelsnWidth
- the width of the image, in pixelsnHeight
- the height of the image, in pixels
IRPGraphEdge addNewEdgeByType(java.lang.String metaType, IRPGraphElement src, int xSrcPosition, int ySrcPosition, IRPGraphElement trg, int xTrgPosition, int yTrgPosition)
metaType
- the type of connector element to add to the statechart. The strings that can be used for this parameter are: "anchor", "compRealization", "Containment Arrow", and "communication path".src
- the graphical element that is the source for the connectorxSrcPosition
- the distance, in pixels, from the the left edge of the diagram to a point within the source graphical elementySrcPosition
- the distance, in pixels, from the the top edge of the diagram to a point within the source graphical elementtrg
- the graphical element that is the target for the connectorxTrgPosition
- the distance, in pixels, from the the left edge of the diagram to a point within the target graphical elementyTrgPosition
- the distance, in pixels, from the the top edge of the diagram to a point within the target graphical element
addNewEdgeForElement(com.telelogic.rhapsody.core.IRPModelElement, com.telelogic.rhapsody.core.IRPGraphNode, int, int, com.telelogic.rhapsody.core.IRPGraphNode, int, int)
IRPGraphEdge addNewEdgeForElement(IRPModelElement element, IRPGraphNode src, int xSrcPosition, int ySrcPosition, IRPGraphNode trg, int xTrgPosition, int yTrgPosition)
element
- the model element to add to the statechart.src
- the graphical element that is the source for the connectorxSrcPosition
- the distance, in pixels, from the the left edge of the diagram to a point within the source graphical elementySrcPosition
- the distance, in pixels, from the the top edge of the diagram to a point within the source graphical elementtrg
- the graphical element that is the target for the connectorxTrgPosition
- the distance, in pixels, from the the left edge of the diagram to a point within the target graphical elementyTrgPosition
- the distance, in pixels, from the the top edge of the diagram to a point within the target graphical element
IRPGraphNode addNewNodeByType(java.lang.String metaType, int xPosition, int yPosition, int nWidth, int nHeight)
metaType
- the type of element to add to the diagram. The strings that can be used for this parameter are: "OrState"(for And Line), "Note"; panel diagram elements: "Knob", "Gauge", "Meter", "LevelIndicator", "MatrixDisplay", "DigitalDisplay", "Led", "OnOffSwitch", "PushButton", "ButtonArray", "TextBox", "Slider"; free shapes: "Polyline", "Ploygon", "Rectangle", "Polycurve", "Closed Curve","Ellipse","Image".xPosition
- the position of the left edge of the graphical object, in pixels, relative to the left edge of the diagramyPosition
- the position of the top edge of the graphical object, in pixels, relative to the top edge of the diagramnWidth
- the width of the graphical objectnHeight
- the height of the graphical object
addNewNodeForElement(com.telelogic.rhapsody.core.IRPModelElement, int, int, int, int)
IRPGraphNode addNewNodeForElement(IRPModelElement element, int xPosition, int yPosition, int nWidth, int nHeight)
element
- the model element to add to the statechart.xPosition
- the position of the left edge of the graphical object, in pixels, relative to the left edge of the diagramyPosition
- the position of the top edge of the graphical object, in pixels, relative to the top edge of the diagramnWidth
- the width of the graphical objectnHeight
- the height of the graphical object
IRPGraphElement addTextBox(java.lang.String text, int xPosition, int yPosition, int nWidth, int nHeight)
text
- the text that should be displayedxPosition
- the x coordinate for the top left corner of the box, in pixelsyPosition
- the y coordinate for the top left corner of the box, in pixelsnWidth
- the width of the text box, in pixelsnHeight
- the height of the text box, in pixels
IRPAXViewCtrl openDiagramView()
void closeDiagram()
void createGraphics()
void deleteState(IRPState state)
state
- the state to deleteint findTrigger(IRPInterfaceItem Item)
Item
- the IRPInterfaceItem element to check
IRPCollection getAllTriggers()
IRPCollection getElementsInDiagram()
IRPCollection getGraphicalElements()
IRPStatechart getInheritsFrom()
int getIsMainBehavior()
int getIsOverridden()
IRPClassifier getItsClass()
void getPicture(java.lang.String filename)
filename
- the full path to use for saving the fileIRPCollection getPictureAs(java.lang.String firstFileName, java.lang.String imageFormat, int getImageMaps, IRPCollection diagrammap)
firstFileName
- the name to use for the file created. If more than one file is created, the filenames used will be based on the following convention: firstFileNameZ_X_Y, where Z is the number of the created file, X is the number of the page along the X vector, and Y is the number of the page along the Y vector.imageFormat
- the graphic format in which the diagram should be saved. This can be one of the following: EMF, BMP, JPEG, JPG, TIFF.getImageMaps
- use this argument to indicate whether the method should also provide a collection of IRPImageMap objects that can be used to construct an HTML image map for the diagram. (Use 1 if you want this information, else use 0.)diagrammap
- The collection to use to store the IRPImageMap objects containing the required information for constructing an HTML image map
IRPCollection getPictureAsDividedMetafiles(java.lang.String firstFileName)
firstFileName
- the name to use for the first file created. If more than one file is created, the filenames used will be based on the following convention: firstFileNameZ_X_Y, where Z is the number of the created file, X is the number of the page along the X vector, and Y is the number of the page along the Y vector.
IRPCollection getPicturesWithImageMap(java.lang.String firstFileName, IRPCollection diagrammap)
firstFileName
- the name to use for the file created. If more than one file is created, the filenames used will be based on the following convention: firstFileNameZ_X_Y, where Z is the number of the created file, X is the number of the page along the X vector, and Y is the number of the page along the Y vector.diagrammap
- The collection to use to store the IRPImageMap objects containing the required information for constructing an HTML image map
IRPState getRootState()
IRPStatechartDiagram getStatechartDiagram()
void overrideInheritance()
void populateDiagram(IRPCollection elementsToPopulate, IRPCollection relationsTypes, java.lang.String createContent)
elementsToPopulate
- the elements (nodes) to add to the diagramrelationsTypes
- the types of relations that should be drawn on the diagram. You can use the string AllRelations to display all types, or use any combination of the following strings: Composition, Association, Link, Dependency, Inheritance, Anchor, InformationFlowcreateContent
- the elements that should be included in addition to those specified. This argument can take any of the following strings: among, from, to, fromto. If you use "among", only the elements you specified will be included. If you use one of the other strings, the diagram will also include elements that the selected elements are related tovoid setAsMainBehavior()
void setShowDiagramFrame(int bShow)
bShow
- use 1 to show the diagram frame, 0 to hide the frame.void unoverrideInheritance()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |