UmlSequenceDiagramPrinterConfigurationToHtml Class Reference

Inheritance diagram for UmlSequenceDiagramPrinterConfigurationToHtml:

UmlSequenceDiagramPrinterConfigurationInterface

List of all members.

Public Member Functions

 setPublicPath ($strPublicPath)
 getPublicPath ()
 setCallerPath ($strCallerPath)
 getCallerPath ()
 setExternalAccess ($booExternalAccess)
 getExternalAccess ()
 setWidth ($intWidth)
 getWidth ()
 setZoom ($intZoom)
 getZoom ()
 setLinePercentHeight ($intPercentHeight)
 getLinePercentHeight ()
 setLineActorPercentHeight ($intActorPercentHeight)
 getLineActorPercentHeight ()
 setActorHeaderPercentWidth ($intActorHeaderPercentWidth)
 getActorHeaderPercentWidth ()
 setActorLogoPercentWidth ($intActorLogoPercentWidth)
 getActorLogoPercentWidth ()
 setActorBarPercentWidth ($intActorBarPercentWidth)
 getActorBarPercentWidth ()
 setPercentFont ($intPercentFont)
 getPercentFont ()
 setEmbeded ($booEmbeded)
 getEmbeded ()
 setShowDetails ($booShowDetails)
 getShowDetails ()
 getPublicFolderPath ()
 perform ($objUmlSequenceDiagram)

Protected Attributes

 $strPublicPath
 $strCallerPath
 $booExternalAccess = false
 $intWidth = 800
 $intLinePercentHeight = 25
 $intLineActorPercentHeight = 40
 $intZoom = 100
 $intActorHeaderPercentWidth = 75
 $intActorLogoPercentWidth = 70
 $intActorBarPercentWidth = 2
 $intPercentFont = 30
 $booEmbeded = false
 $booShowDetails = true

Detailed Description

Configuration object to the UmlSequenceDiagramPrinterToHtml

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

Definition at line 14 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Member Function Documentation

getActorBarPercentWidth (  ) 

Get the actor bar percent width

Set the width of the actor bar relating to the width of one actor area into the diagram

See also:
UmlSequenceDiagramPrinterInterface::getActorBarPercentWidth()
Returns:
integer $intActorBarPercentWidth

Definition at line 386 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00387     {
00388         return $this->intActorBarPercentWidth;
00389     }

getActorHeaderPercentWidth (  ) 

Get the actor header percent width

Set the width of the actor header relating to the width of one actor area into the diagram

See also:
UmlSequenceDiagramPrinterInterface::getActorHeaderPercentWidth()
Returns:
integer $intActorHeaderPercentWidth

Definition at line 332 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00333     {
00334         return $this->intActorHeaderPercentWidth;
00335     }

getActorLogoPercentWidth (  ) 

Get the width ( in percent ) of the logo image into the actor header

See also:
UmlSequenceDiagramPrinterInterface::getActorLogoPercentWidth()
Returns:
integer $intActorLogoPercentWidth

Definition at line 356 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00357     {
00358         return $this->intActorLogoPercentWidth;
00359     }

getCallerPath (  ) 

Get the caller path of the code execution

See also:
UmlSequenceDiagramPrinterInterface::getCallerPath()
Returns:
string

Implements UmlSequenceDiagramPrinterConfigurationInterface.

Definition at line 172 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by getPublicFolderPath().

00173     {
00174         return $this->strCallerPath;
00175     }

getEmbeded (  ) 

Get if the diagram is embeded

Returns:
integer

Definition at line 439 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00440     {
00441         return $this->booEmbeded;
00442     }

getExternalAccess (  ) 

Get true if the code is executed by external access and false</false> if not

See also:
UmlSequenceDiagramPrinterInterface::getExternalAccess()
Returns:
boolean

Implements UmlSequenceDiagramPrinterConfigurationInterface.

Definition at line 198 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by getPublicFolderPath().

00199     {
00200         return $this->booExternalAccess;
00201     }

getLineActorPercentHeight (  ) 

Get the height of the actor line in relative proporsion to the width

See also:
UmlSequenceDiagramPrinterInterface::getLineActorPercentHeight()
Returns:
integer;

Definition at line 302 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00303     {
00304         return $this->intLineActorPercentHeight;
00305     }

getLinePercentHeight (  ) 

Get the height of each line in relative proporsion to the width

See also:
UmlSequenceDiagramPrinterInterface::getLinePercentHeight()
Returns:
integer;

Implements UmlSequenceDiagramPrinterConfigurationInterface.

Definition at line 278 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00279     {
00280         return $this->intLinePercentHeight;
00281     }

getPercentFont (  ) 

Get the size of the font in percent width

Get the size of the font in percent width relating to the width of one actor area into the diagram and images

See also:
UmlSequenceDiagramPrinterInterface::getPercentFont()
Returns:
integer $intPercentFont

Definition at line 417 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00418     {
00419         return $this->intPercentFont;
00420     }

getPublicFolderPath (  ) 

Get the public folder path

Returns:
string

Definition at line 471 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $strPublicPath, getCallerPath(), getExternalAccess(), getPublicPath(), and CorujaFileManipulation::getRelativePath().

00472     {
00473         if( $this->getExternalAccess() )
00474         {
00475             $strPublicPath = $this->getPublicPath();
00476         }
00477         else
00478         {
00479             if  (
00480                     ( $this->getCallerPath() != null )
00481                     and
00482                     ( $this->getPublicPath() != null )
00483                 )
00484             {
00485                 $strPublicPath = CorujaFileManipulation::getRelativePath(
00486                     $this->getCallerPath(),
00487                     $this->getPublicPath()
00488                 );
00489             }
00490             elseif
00491                 (
00492                     ( $this->getCallerPath() == null )
00493                     and
00494                     ( $this->getPublicPath() != null )
00495                 )
00496             {
00497                 $strPublicPath = $this->getPublicPath();
00498             }
00499             else
00500             {
00501                 $strPublicPath = "./";
00502             }
00503         }
00504         return $strPublicPath;
00505     }

getPublicPath (  ) 

Get the public path of the code execution

See also:
UmlSequenceDiagramPrinterInterface::getPublicPath()
Returns:
string

Implements UmlSequenceDiagramPrinterConfigurationInterface.

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

Referenced by getPublicFolderPath().

00149     {
00150         return $this->strPublicPath;
00151     }

getShowDetails (  ) 

Get if the diagram should show the details

Returns:
integer

Definition at line 461 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00462     {
00463         return $this->booShowDetails;
00464     }

getWidth (  ) 

Get the width in pixels of the diagram

See also:
UmlSequenceDiagramPrinterInterface::getWidth()
Returns:
integer $intWidth

Implements UmlSequenceDiagramPrinterConfigurationInterface.

Definition at line 222 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00223     {
00224         return $this->intWidth;
00225     }

getZoom (  ) 

Get the zoom of the diagram

The zoom reduce / enlarge the diagram keeping the proportion beteewn the dimension and images

See also:
UmlSequenceDiagramPrinterInterface::getZoom()
Returns:
integer $intZoom

Implements UmlSequenceDiagramPrinterConfigurationInterface.

Definition at line 254 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00255     {
00256         return $this->intZoom;
00257     }

perform ( $  objUmlSequenceDiagram  ) 

Parameters:
UmlSequenceDiagram $objUmlSequenceDiagram
Returns:
string

Definition at line 512 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References UmlSequenceDiagramPrinterToHtml::getInstance().

00513     {
00514         return UmlSequenceDiagramPrinterToHtml::getInstance()->perform( $objUmlSequenceDiagram );
00515     }

setActorBarPercentWidth ( $  intActorBarPercentWidth  ) 

Set the actor bar percent width

Set the width of the actor bar relating to the width of one actor area into the diagram

See also:
UmlSequenceDiagramPrinterInterface::setActorBarPercentWidth( $intActorBarPercentWidth )
Parameters:
integer $intActorBarPercentWidth
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Definition at line 371 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $intActorBarPercentWidth.

00372     {
00373         $this->intActorBarPercentWidth = (integer)$intActorBarPercentWidth;
00374         return $this;
00375     }

setActorHeaderPercentWidth ( $  intActorHeaderPercentWidth  ) 

Set the actor header percent width

Set the width of the actor header relating to the width of one actor area into the diagram

See also:
UmlSequenceDiagramPrinterInterface::setActorHeaderPercentWidth( $intActorHeaderPercentWidth )
Parameters:
integer $intActorHeaderPercentWidth
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Definition at line 317 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $intActorHeaderPercentWidth.

00318     {
00319         $this->intActorHeaderPercentWidth = (integer)$intActorHeaderPercentWidth;
00320         return $this;
00321     }

setActorLogoPercentWidth ( $  intActorLogoPercentWidth  ) 

Set the width ( in percent ) of the logo image into the actor header

See also:
UmlSequenceDiagramPrinterInterface::setActorLogoPercentWidth( $intActorLogoPercentWidth )
Parameters:
integer $intActorLogoPercentWidth
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Definition at line 344 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $intActorLogoPercentWidth.

00345     {
00346         $this->intActorLogoPercentWidth = (integer)$intActorLogoPercentWidth;
00347         return $this;
00348     }

setCallerPath ( $  strCallerPath  ) 

Set the caller path of the code execution

See also:
UmlSequenceDiagramPrinterInterface::setCallerPath( string )
Parameters:
string $strCallerPath
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Implements UmlSequenceDiagramPrinterConfigurationInterface.

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

References $strCallerPath.

00161     {
00162         $this->strCallerPath = (string)$strCallerPath;
00163         return $this;
00164     }

setEmbeded ( $  booEmbeded  ) 

Set if the diagram is embeded

Parameters:
integer $booEmbeded
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Definition at line 428 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $booEmbeded.

00429     {
00430         $this->booEmbeded = $booEmbeded;
00431         return $this;
00432     }

setExternalAccess ( $  booExternalAccess  ) 

Set true if the code is executed by external access and false</false> if not

See also:
UmlSequenceDiagramPrinterInterface::setExternalAccess( boolean )
Parameters:
boolean $booExternalPath
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Implements UmlSequenceDiagramPrinterConfigurationInterface.

Definition at line 185 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $booExternalAccess.

00186     {
00187         $this->booExternalAccess = (boolean)$booExternalAccess;
00188         return $this;
00189     }

setLineActorPercentHeight ( $  intActorPercentHeight  ) 

Set the height of each line in relative proporsion to the width

See also:
UmlSequenceDiagramPrinterInterface::setLineActorPercentHeight( integer )
Parameters:
integer $intActorPercentHeight
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Definition at line 290 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00291     {
00292         $this->intLineActorPercentHeight = (integer)$intActorPercentHeight;
00293         return $this;
00294     }

setLinePercentHeight ( $  intPercentHeight  ) 

Set the height of each line in relative proporsion to the width

See also:
UmlSequenceDiagramPrinterInterface::setLinePercentHeight( integer )
Parameters:
integer $intPercentHeight
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Implements UmlSequenceDiagramPrinterConfigurationInterface.

Definition at line 266 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

00267     {
00268         $this->intLinePercentHeight = (integer)$intPercentHeight;
00269         return $this;
00270     }

setPercentFont ( $  intPercentFont  ) 

Set the size of the font in percent width

Set the size of the font in percent width relating to the width of one actor area into the diagram

See also:
UmlSequenceDiagramPrinterInterface::setPercentFont( $intPercentFont )
Parameters:
integer $intPercentFont
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Definition at line 401 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $intPercentFont.

00402     {
00403         $this->intPercentFont = (integer)$intPercentFont;
00404         return $this;
00405     }

setPublicPath ( $  strPublicPath  ) 

Set the public path of the code execution

See also:
UmlSequenceDiagramPrinterInterface::setPublicPath( string )
Parameters:
string $strPublicPath
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Implements UmlSequenceDiagramPrinterConfigurationInterface.

Definition at line 136 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $strPublicPath.

00137     {
00138         $this->strPublicPath = (string)$strPublicPath;
00139         return $this;
00140     }

setShowDetails ( $  booShowDetails  ) 

Set if the diagram should show the details

Parameters:
integer $booShowDetails
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Definition at line 450 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $booShowDetails.

00451     {
00452         $this->booShowDetails = $booShowDetails;
00453         return $this;
00454     }

setWidth ( $  intWidth  ) 

Set the width in pixels of the diagram

See also:
UmlSequenceDiagramPrinterInterface::setWidth( integer )
Parameters:
integer $intWidth
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Implements UmlSequenceDiagramPrinterConfigurationInterface.

Definition at line 210 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $intWidth.

00211     {
00212         $this->intWidth = (integer)$intWidth;
00213         return $this;
00214     }

setZoom ( $  intZoom  ) 

Set the zoom of the diagram

The zoom reduce / enlarge the diagram keeping the proportion beteewn the dimension and images

See also:
UmlSequenceDiagramPrinterInterface::setZoom( $intZoom )
Parameters:
integer $intZoom
Returns:
UmlSequenceDiagramPrinterConfigurationToHtml me

Implements UmlSequenceDiagramPrinterConfigurationInterface.

Definition at line 238 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

References $intZoom.

00239     {
00240         $this->intZoom = (integer)$intZoom;
00241         return $this;
00242     }

Member Data Documentation

$booEmbeded = false [protected]

If embeded the script will not create the html header tags but just paste a script with the diagram element.

If not embeded the script will create the full html with all the header needed.

boolean

Default: false

Definition at line 118 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by setEmbeded().

$booExternalAccess = false [protected]

flag if the access is by external link

boolean

Default: false

Definition at line 36 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by setExternalAccess().

$booShowDetails = true [protected]

Flag to control if the detail description should be print into the diagram.

boolean

Default: true

Definition at line 127 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by setShowDetails().

$intActorBarPercentWidth = 2 [protected]

width ( in percent ) for each actor bar relating to the width of one actor

integer

Default: 2

Definition at line 97 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by setActorBarPercentWidth().

$intActorHeaderPercentWidth = 75 [protected]

width ( in percent ) for each actor header relating to the width of one actor

integer

Default: 10

Definition at line 79 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by setActorHeaderPercentWidth().

$intActorLogoPercentWidth = 70 [protected]

width ( in percent ) of the logo image into the actor header

integer

Default: 70

Definition at line 88 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by setActorLogoPercentWidth().

$intLineActorPercentHeight = 40 [protected]

Height of each line in relative proporsion to the width

integer

Default: 10

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

$intLinePercentHeight = 25 [protected]

Height of each line in relative proporsion to the width

integer

Default: 10

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

$intPercentFont = 30 [protected]

size ( in percent ) of text font relating to the width of one actor

integer

Default: 10

Definition at line 106 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by setPercentFont().

$intWidth = 800 [protected]

Width in pixels of the diagram

integer

Default: 800

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

Referenced by setWidth().

$intZoom = 100 [protected]

The zoom reduce / enlarge the diagram keeping the proportion beteewn the dimension and images

integer

Default: 100

Definition at line 70 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by setZoom().

$strCallerPath [protected]

caller path of the code execution

string

Definition at line 28 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by setCallerPath().

$strPublicPath [protected]

public path of the code execution

string

Definition at line 21 of file UmlSequenceDiagramPrinterConfigurationToHtml.class.php.

Referenced by getPublicFolderPath(), and setPublicPath().

The documentation for this class was generated from the following file:
Generated on Thu Feb 3 03:55:04 2011 for CodeToDiagram by  doxygen 1.5.9