|
||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectdk.klafbang.tincpn.animation.plugin.MSC
public class MSC
This animation objects allows you to draw message-sequence charts easily.
Constructor Summary | |
---|---|
MSC(java.lang.String name,
java.lang.String id)
Constructs a MSC object. |
Method Summary | |
---|---|
void |
addEvent(java.lang.String from,
java.lang.String to,
java.lang.String text)
Add an event from one process to another with the given text. |
void |
addEventStyle(java.lang.String from,
java.lang.String to,
java.lang.String text,
java.lang.String style)
Add an event from one process to another with the given text and style. |
void |
addInternalEvent(java.lang.String process,
java.lang.String text)
Add an internal event to the given process. |
void |
addInternalEventStyle(java.lang.String process,
java.lang.String text,
java.lang.String style)
Add an internal event to the given process. |
void |
addLine(java.lang.String text)
|
void |
addProcess(java.lang.String name)
Add a new process to the MSC. |
void |
addProcessStyle(java.lang.String name,
java.lang.String style)
Add a new process to the MSC. |
java.lang.String |
createStyle(java.lang.String foreground,
java.lang.String background,
int width)
Create a new style. |
void |
dropEvent(java.lang.String identifier)
Drop a dangling event. |
void |
endEvent(java.lang.String identifier,
java.lang.String to)
Attach a dangling event to an end process. |
void |
endEventStyle(java.lang.String identifier,
java.lang.String to,
java.lang.String style)
Attach a dangling event to an end process and updates its style. |
dk.klafbang.tincpn.gui.sheet.Sheet |
getSheet()
|
java.lang.String |
startEvent(java.lang.String from,
java.lang.String text)
Add an event starting at a process, but which does not end anywhere with the given text. |
java.lang.String |
startEventStyle(java.lang.String from,
java.lang.String text,
java.lang.String style)
Add an event starting at a process, but which does not end anywhere with the given text and style. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MSC(java.lang.String name, java.lang.String id)
name
- of the MSCid
- Method Detail |
---|
public dk.klafbang.tincpn.gui.sheet.Sheet getSheet()
getSheet
in interface dk.klafbang.tincpn.animation.AnimationController
AnimationController.getSheet()
public java.lang.String createStyle(java.lang.String foreground, java.lang.String background, int width) throws java.lang.NumberFormatException
foreground
- the foreground color as a string "0xRRGGBB" where RR,
GG, BB are hexadecimal encodings of the color's red,
green, and blue components. E.g. 0xff0000 would represent
a bright red, 0xffff00 a bright yellow, and 0x7f7fff a
light blue.background
- the background color in the same format as the
foreground color.width
- the linewidth (100 is the default value for events, 200
the default for processes, 0 is a hair-line, more than 400
looks stupid)
java.lang.NumberFormatException
public void addProcess(java.lang.String name)
name
- the name of the new Processpublic void addProcessStyle(java.lang.String name, java.lang.String style)
name
- the name of the new Processstyle
- a style id returned by createStylepublic void addEvent(java.lang.String from, java.lang.String to, java.lang.String text) throws java.lang.Exception
from
- the name of the process to create the event fromto
- the name of the process to create the event totext
- the text of the event
java.lang.Exception
public void addEventStyle(java.lang.String from, java.lang.String to, java.lang.String text, java.lang.String style) throws java.lang.Exception
from
- the name of the process to create the event fromto
- the name of the process to create the event totext
- the text of the eventstyle
- a style id returned by createStyle
java.lang.Exception
public java.lang.String startEvent(java.lang.String from, java.lang.String text) throws java.lang.Exception
from
- name of the process to create the event fromtext
- the text of the event
java.lang.Exception
public java.lang.String startEventStyle(java.lang.String from, java.lang.String text, java.lang.String style) throws java.lang.Exception
from
- name of the process to create the event fromtext
- the text of the eventstyle
- a style id returned by createStyle
java.lang.Exception
public void endEvent(java.lang.String identifier, java.lang.String to) throws java.lang.Exception
identifier
- the id returned by startEventto
- name of the process to end the event on
java.lang.Exception
public void endEventStyle(java.lang.String identifier, java.lang.String to, java.lang.String style) throws java.lang.Exception
identifier
- the id returned by startEventto
- name of the process to end the event onstyle
- a style id returned by createStyle
java.lang.Exception
public void dropEvent(java.lang.String identifier) throws java.lang.Exception
identifier
- the id returned by startEvent
java.lang.Exception
public void addInternalEvent(java.lang.String process, java.lang.String text) throws java.lang.Exception
process
- the name of the process to add the event totext
- the text of the internal event
java.lang.Exception
@ToDo(severity=TRIVIAL, value="Long texts on the last processes cause problems with the bounds calculation") public void addInternalEventStyle(java.lang.String process, java.lang.String text, java.lang.String style) throws java.lang.Exception
process
- the name of the process to add the event totext
- the text of the internal eventstyle
- a style id returned by createStyle
java.lang.Exception
public void addLine(java.lang.String text)
text
-
|
||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |