UmlSequenceDiagramNote Class Reference

List of all members.

Public Member Functions
	setContent ($strContent)
	getContent ()
	setShowLine ($booShowLine)
	getShowLine ()
	setActor (UmlSequenceDiagramActor $objActor)
	getActor ()
	setLeft ($booLeft)
	getLeft ()
	setRight ($booRight)
	getRight ()
	putInLeftOfActor (UmlSequenceDiagramActor $objActor)
	putInRightOfActor (UmlSequenceDiagramActor $objActor)
Protected Attributes
	$strContent = ""
	$booShowLine = false
	$booLeft = true
	$objActor

---

Detailed Description

UmlSequenceDiagramNote append a note what helps to describe the UmlSequenceDiagram

Notes help to describe some information about a slice of the diagram. As with all UML Diagram, the Notes are shown in a rectangle with a folder-olver corner.

Author:

Thiago Henrique Ramos da Mata <thiago.henrique.mata@gmail.com>

Definition at line 19 of file UmlSequenceDiagramNote.class.php.

---

Member Function Documentation

getActor

(

)

Get the actor what the note it is relative to

Returns:

UmlSequenceDiagramActor

Definition at line 115 of file UmlSequenceDiagramNote.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getNote().

    {
        return $this->objActor;
    }

getContent

(

)

Get the note content

Returns:

string

Definition at line 71 of file UmlSequenceDiagramNote.class.php.

Referenced by UmlSequenceDiagramPrinterToHtml::getNote().

    {
        return $this->strContent;
    }

getLeft

(

)

Get if the note should be in the left of the actor

Returns:

boolean

Definition at line 137 of file UmlSequenceDiagramNote.class.php.

Referenced by getRight().

    {
        return $this->booLeft;
    }

getRight

(

)

Get if the note should be in the right of the actor

Returns:

boolean

Definition at line 160 of file UmlSequenceDiagramNote.class.php.

References $booLeft, and getLeft().

    {
        $booLeft = $this->getLeft();
        $booRight = !$booLeft;
        return $booRight;
    }

getShowLine

(

)

Get the show line option

Returns:

boolean

Definition at line 93 of file UmlSequenceDiagramNote.class.php.

    {
        return $this->booShowLine;
    }

putInLeftOfActor

(

UmlSequenceDiagramActor $

objActor

)

Put the note on the left of the received actor

Parameters:

UmlSequenceDiagramActor

$objActor

Returns:

UmlSequenceDiagramNote

Definition at line 173 of file UmlSequenceDiagramNote.class.php.

References setActor(), and setLeft().

    {
        $this->setActor( $objActor );
        $this->setLeft( true );
        return $this;
    }

putInRightOfActor

(

UmlSequenceDiagramActor $

objActor

)

Put the note on the right of the received actor

Parameters:

UmlSequenceDiagramActor

$objActor

Returns:

UmlSequenceDiagramNote

Definition at line 186 of file UmlSequenceDiagramNote.class.php.

References setActor(), and setRight().

    {
        $this->setActor( $objActor );
        $this->setRight( true );
        return $this;
    }

setActor

(

UmlSequenceDiagramActor $

objActor

)

Set the actor what the note it is relative to

Parameters:

UmlSequenceDiagramActor

$objActor

Returns:

UmlSequenceDiagramNote

Definition at line 104 of file UmlSequenceDiagramNote.class.php.

Referenced by putInLeftOfActor(), and putInRightOfActor().

    {
        $this->objActor = $objActor;
        return $this;
    }

setContent

(

$

strContent

)

Set the note content

Parameters:

string

$strContent

Returns:

UmlSequenceDiagramNote

Definition at line 60 of file UmlSequenceDiagramNote.class.php.

References $strContent.

    {
        $this->strContent = (string)$strContent;
        return $this;
    }

setLeft

(

$

booLeft

)

Set if the note should be in the left of the actor

Parameters:

boolean

$booLeft

Returns:

UmlSequenceDiagramNote

Definition at line 126 of file UmlSequenceDiagramNote.class.php.

References $booLeft.

Referenced by putInLeftOfActor(), and setRight().

    {
        $this->booLeft = (boolean)$booLeft;
        return $this;
    }

setRight

(

$

booRight

)

Set if the note should be in the right of the actor

Parameters:

boolean

$booRight

Returns:

UmlSequenceDiagramNote

Definition at line 148 of file UmlSequenceDiagramNote.class.php.

References $booLeft, and setLeft().

Referenced by putInRightOfActor().

    {
        $booRight = (boolean)$booRight;
        $booLeft = !$booRight;
        return $this->setLeft( $booLeft );
    }

setShowLine

(

$

booShowLine

)

Set the show line option

Parameters:

boolean

$booShowLine

Returns:

UmlSequenceDiagramNote

Definition at line 82 of file UmlSequenceDiagramNote.class.php.

References $booShowLine.

    {
        $this->booShowLine = (boolean) $booShowLine;
        return $this;
    }

---

Member Data Documentation

$booLeft = true [protected]

Flag to control the position of the note in relative to the actor. true is on the left and false is on the right

boolean

Definition at line 44 of file UmlSequenceDiagramNote.class.php.

Referenced by getRight(), setLeft(), and setRight().

$booShowLine = false [protected]

Flag to control if the line between the actor and the note should be visible or not

boolean

Definition at line 35 of file UmlSequenceDiagramNote.class.php.

Referenced by setShowLine().

$objActor [protected]

Actor what the note it is relative to

UmlSequenceDiagramActor

Definition at line 52 of file UmlSequenceDiagramNote.class.php.

$strContent = "" [protected]

String with the content of the diagram note

string

Definition at line 26 of file UmlSequenceDiagramNote.class.php.

Referenced by setContent().

---

The documentation for this class was generated from the following file:

• components/umlSequenceDiagram/UmlSequenceDiagramNote.class.php