Documentation

Comment

in package

• Application

implements IComparable, Stringable

Table of Contents

Interfaces

IComparable

Stringable

Constants

TEXTBOX_DIRECTION_AUTO  = 'auto'

TEXTBOX_DIRECTION_CONTEXT  = 'auto'

TEXTBOX_DIRECTION_LTR  = 'ltr'

TEXTBOX_DIRECTION_RTL  = 'rtl'

Properties

$alignment  : string

Alignment.

$author  : string

Author.

$backgroundImage  : Drawing

Background image in comment.

$fillColor  : Color

Comment fill color.

$height  : string

Comment height (CSS style, i.e. XXpx or YYpt).

$marginLeft  : string

Left margin (CSS style, i.e. XXpx or YYpt).

$marginTop  : string

Top margin (CSS style, i.e. XXpx or YYpt).

$text  : RichText

Rich text comment.

$textboxDirection  : string

$visible  : bool

Visible.

$width  : string

Comment width (CSS style, i.e. XXpx or YYpt).

Methods

__clone()  : mixed

Implement PHP __clone to create a deep clone, not just a shallow copy.

__construct()  : mixed

Create a new Comment.

__toString()  : string

Convert to string.

getAlignment()  : string

getAuthor()  : string

Get Author.

getBackgroundImage()  : Drawing

Returns background image.

getFillColor()  : Color

Get fill color.

getHashCode()  : string

Get hash code.

getHeight()  : string

Get comment height (CSS style, i.e. XXpx or YYpt).

getMarginLeft()  : string

Get left margin (CSS style, i.e. XXpx or YYpt).

getMarginTop()  : string

Get top margin (CSS style, i.e. XXpx or YYpt).

getText()  : RichText

Get Rich text comment.

getTextboxDirection()  : string

getVisible()  : bool

Is the comment visible by default?

getWidth()  : string

Get comment width (CSS style, i.e. XXpx or YYpt).

hasBackgroundImage()  : bool

Check is background image exists.

setAlignment()  : self

setAuthor()  : self

Set Author.

setBackgroundImage()  : self

Sets background image.

setFillColor()  : self

Set fill color.

setHeight()  : self

Set comment height (CSS style, i.e. XXpx or YYpt). Default unit is pt.

setMarginLeft()  : self

Set left margin (CSS style, i.e. XXpx or YYpt). Default unit is pt.

setMarginTop()  : self

Set top margin (CSS style, i.e. XXpx or YYpt). Default unit is pt.

setSizeAsBackgroundImage()  : self

Sets size of comment as size of background image.

setText()  : self

Set Rich text comment.

setTextboxDirection()  : self

setVisible()  : self

Set comment default visibility.

setWidth()  : self

Set comment width (CSS style, i.e. XXpx or YYpt). Default unit is pt.