\src\Utils\Graphics2D\DrawingPanes\HtmlMapDrawingPane.inc

Show: inherited
Table of Contents

\Utils\Graphics2D\DrawingPanes\HtmlMapDrawingPane

Package: Default

This class implements a drawing pane for HTML map output.

Parent(s)
\Utils\Graphics2D\DrawingPanes\DomDrawingPane < \Utils\Graphics2D\DrawingPanes\DrawingPane

Properties

Propertyprotectedstring  $classNameEdge= ''rt_edge''
inherited

the name of the CSS class for the edge shapes.

Inherited from: \Utils\Graphics2D\DrawingPanes\DomDrawingPane::$classNameEdge
Default value'rt_edge'Details
Type
string
Inherited_from
\Utils\Graphics2D\DrawingPanes\DomDrawingPane::$classNameEdge  
Propertyprotectedstring  $classNameNode= ''rt_node''
inherited

the name of the CSS class for the node shapes.

Inherited from: \Utils\Graphics2D\DrawingPanes\DomDrawingPane::$classNameNode
Default value'rt_node'Details
Type
string
Inherited_from
\Utils\Graphics2D\DrawingPanes\DomDrawingPane::$classNameNode  
Propertyprotected\Utils\Geom\Dimension  $dimension= '0'
inherited

the dimension of the document

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::$dimension
Propertypublicmixed  $document= 'null'
inherited

the wrapped document

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::$document
Default valuenullDetails
Type
mixed
Inherited_from
\Utils\Graphics2D\DrawingPanes\DrawingPane::$document  
Propertyprotected\Utils\Color\Color  $fillColor= 'null'
inherited

the current fill color of the drawing pane

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::$fillColor
Default valuenullDetails
Type
\Utils\Color\Color
Inherited_from
\Utils\Graphics2D\DrawingPanes\DrawingPane::$fillColor  
Propertyprotected\Utils\Color\Color  $fontColor= 'null'
inherited

the current font color of the drawing pane

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::$fontColor
Default valuenullDetails
Type
\Utils\Color\Color
Inherited_from
\Utils\Graphics2D\DrawingPanes\DrawingPane::$fontColor  
Propertyprotectedstring  $fontFamily= 'null'
inherited

the current font family of the drawing pane

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::$fontFamily
Default valuenullDetails
Type
string
Inherited_from
\Utils\Graphics2D\DrawingPanes\DrawingPane::$fontFamily  
Propertyprotectedint  $fontSize= 'null'
inherited

the current font size in pixels of the drawing pane

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::$fontSize
Default valuenullDetails
Type
int
Inherited_from
\Utils\Graphics2D\DrawingPanes\DrawingPane::$fontSize  
Propertyprotected\Utils\Graphics2D\DrawingPanes\DOMDocumentFragment  $fragment= 'null'
inherited

the DOM document fragment that holds the source code of the export

Inherited from: \Utils\Graphics2D\DrawingPanes\DomDrawingPane::$fragment
Default valuenullDetails
Type
\Utils\Graphics2D\DrawingPanes\DOMDocumentFragment
Inherited_from
\Utils\Graphics2D\DrawingPanes\DomDrawingPane::$fragment  
Propertyprivatestring  $mapName= 'null'

the name of the HTML map element

Default valuenullDetails
Type
string
Propertyprotected\Utils\Color\Color  $strokeColor= 'null'
inherited

the current stroke color of the drawing pane

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::$strokeColor
Default valuenullDetails
Type
\Utils\Color\Color
Inherited_from
\Utils\Graphics2D\DrawingPanes\DrawingPane::$strokeColor  
Propertyprotectedint  $strokeWidth= '1'
inherited

the currect stroke width of the drawing pane

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::$strokeWidth
Default value1Details
Type
int
Inherited_from
\Utils\Graphics2D\DrawingPanes\DrawingPane::$strokeWidth  

Methods

methodpublic__construct( \Utils\Geom\Dimension $dimension ) : void

This method acts as the constructor for the class.

Parameters
Name Type Description
$dimension \Utils\Geom\Dimension

the dimension of the document

methodprotectedappendFragment( \DOMNode $parentElement ) : void
inherited

This method appends the fragment to the given parent element.

Inherited from: \Utils\Graphics2D\DrawingPanes\DomDrawingPane::appendFragment()
Parameters
Name Type Description
$parentElement \DOMNode

the root element to append the internal document fragment to

methodprotectedclearDocument( ) : void
inherited

This method assures that the document is empty before saving it. Otherwise, multiple calls to violate the DOMDocument structure (e.g. multiple ). Creating a new document does not work, as the fragement depends on the first created document.

Inherited from: \Utils\Graphics2D\DrawingPanes\DomDrawingPane::clearDocument()
methodpublicdrawEllipse( \Utils\Geom\Point $center, \Utils\Geom\Dimension $dimension ) : \Utils\Graphics2D\DrawingPanes\IDrawingPane

This method draws an ellipse on the document.

Parameters
Name Type Description
$center \Utils\Geom\Point

the center of the ellipse

$dimension \Utils\Geom\Dimension

the dimension of the ellipse

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\IDrawingPane $this
methodpublicdrawLine( \Utils\Geom\Point $source, \Utils\Geom\Point $target ) : \Utils\Graphics2D\DrawingPanes\IDrawingPane

This method draws a line on the document.

Parameters
Name Type Description
$source \Utils\Geom\Point

the source point of the line

$target \Utils\Geom\Point

the target point of the line

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\IDrawingPane $this
methodpublicdrawPolyLine( \Traversable $points ) : \Utils\Graphics2D\DrawingPanes\IDrawingPane
inherited

This method draws a poly line onto the the document.

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::drawPolyLine()

It expects an traversable of points, where each point is represented by a object of the class Point.

Parameters
Name Type Description
$points \Traversable

the coordinates of the points of the line

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\IDrawingPane $this
methodpublicdrawPolygon( \Traversable $points ) : \Utils\Graphics2D\DrawingPanes\IDrawingPane

This method draws a polygon on the document.

Parameters
Name Type Description
$points \Traversable

the points defining the polygon

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\IDrawingPane $this
methodpublicdrawRectangle( \Utils\Geom\Point $topLeftCorner, \Utils\Geom\Dimension $dimension ) : \Utils\Graphics2D\DrawingPanes\IDrawingPane

This method draws a rectangle on the document.

Parameters
Name Type Description
$topLeftCorner \Utils\Geom\Point

the top left corner of the rectangle

$dimension \Utils\Geom\Dimension

the dimension of the rectangle

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\IDrawingPane $this
methodpublicdrawText( \Utils\Geom\Point $topLeftCorner, \Utils\Graphics2D\DrawingPanes\type $text ) : \Utils\Graphics2D\DrawingPanes\IDrawingPane

This method draws text at the given position.

Parameters
Name Type Description
$topLeftCorner \Utils\Geom\Point

the top left corner of the text to draw

$text \Utils\Graphics2D\DrawingPanes\type

the text to draw

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\IDrawingPane $this
Details
InheritDoc
This method does not do anything, as drawing text on a HTML map does not make sense.  
methodpublicgetClassNameEdge( ) : string
inherited

This method acts as getter for the CSS class name of the edge shapes.

Inherited from: \Utils\Graphics2D\DrawingPanes\DomDrawingPane::getClassNameEdge()
Returns
Type Description
string
methodpublicgetClassNameNode( ) : string
inherited

This method acts as getter for the CSS class name of the node shapes.

Inherited from: \Utils\Graphics2D\DrawingPanes\DomDrawingPane::getClassNameNode()
Returns
Type Description
string
methodpublicsave( ) : string

This method saves this DrawingPane to a string.

Returns
Type Description
string
methodpublicsetClassNameEdge( string $classNameEdge ) : void
inherited

This method acts as setter for the CSS class name of the edge shapes.

Inherited from: \Utils\Graphics2D\DrawingPanes\DomDrawingPane::setClassNameEdge()
Parameters
Name Type Description
$classNameEdge string

the new name of the CSS class for edge shapes return void

methodpublicsetClassNameNode( string $classNameNode ) : void
inherited

This method acts as setter for the CSS class name of the node shapes.

Inherited from: \Utils\Graphics2D\DrawingPanes\DomDrawingPane::setClassNameNode()
Parameters
Name Type Description
$classNameNode string

the new name of the CSS class for node shapes return void

methodpublicsetFillColor( \Utils\Color\Color $fillColor ) : \Utils\Graphics2D\DrawingPanes\DrawingPane
inherited

This method sets the fill color.

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::setFillColor()
Parameters
Name Type Description
$fillColor \Utils\Color\Color

the new fill color

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\DrawingPane $this
methodpublicsetFontColor( \Utils\Color\Color $fontColor ) : \Utils\Graphics2D\DrawingPanes\DrawingPane
inherited

This method sets the font color.

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::setFontColor()
Parameters
Name Type Description
$fontColor \Utils\Color\Color

the new font color

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\DrawingPane $this
methodpublicsetFontFamily( string $fontFamily ) : \Utils\Graphics2D\DrawingPanes\DrawingPane
inherited

This method sets the font familiy.

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::setFontFamily()
Parameters
Name Type Description
$fontFamily string

the name of the new font family

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\DrawingPane $this
methodpublicsetFontSize( int $fontSize ) : \Utils\Graphics2D\DrawingPanes\DrawingPane
inherited

This method sets the font size.

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::setFontSize()
Parameters
Name Type Description
$fontSize int

the new font size in pixel

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\DrawingPane $this
methodpublicsetStrokeColor( \Utils\Color\Color $strokeColor ) : \Utils\Graphics2D\DrawingPanes\DrawingPane
inherited

This method sets the stroke color.

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::setStrokeColor()
Parameters
Name Type Description
$strokeColor \Utils\Color\Color

the new stroke color

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\DrawingPane $this
methodpublicsetStrokeWidth( int $strokeWidth ) : \Utils\Graphics2D\DrawingPanes\DrawingPane
inherited

This method sets the stroke width.

Inherited from: \Utils\Graphics2D\DrawingPanes\DrawingPane::setStrokeWidth()
Parameters
Name Type Description
$strokeWidth int

the new stroke width

Returns
Type Description
\Utils\Graphics2D\DrawingPanes\DrawingPane $this
methodpublictoDOMColor( \Utils\Graphics2D\DrawingPanes\RGBColor $color ) : string
inherited

This method converts a RGBColor to the DOM representation of the color.

Inherited from: \Utils\Graphics2D\DrawingPanes\DomDrawingPane::toDOMColor()
Parameters
Name Type Description
$color \Utils\Graphics2D\DrawingPanes\RGBColor

the color to convert

Returns
Type Description
string the DOM representation of the color
Documentation was generated by DocBlox 0.15.1.