class Comment implements IComparable (View source)

Methods

__construct()

Create a new Comment.

string
getAuthor()

Get Author.

setAuthor(string $author)

Set Author.

getText()

Get Rich text comment.

setText(RichText $pValue)

Set Rich text comment.

string
getWidth()

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

setWidth(string $width)

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

string
getHeight()

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

setHeight(string $value)

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

string
getMarginLeft()

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

setMarginLeft(string $value)

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

string
getMarginTop()

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

setMarginTop(string $value)

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

bool
getVisible()

Is the comment visible by default?

setVisible(bool $value)

Set comment default visibility.

getFillColor()

Get fill color.

setAlignment(string $alignment)

Set Alignment.

string
getAlignment()

Get Alignment.

string
getHashCode()

Get hash code.

__clone()

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

string
__toString()

Convert to string.

Details

__construct()

Create a new Comment.

string getAuthor()

Get Author.

Return Value

string

Comment setAuthor(string $author)

Set Author.

Parameters

string $author

Return Value

Comment

RichText getText()

Get Rich text comment.

Return Value

RichText

Comment setText(RichText $pValue)

Set Rich text comment.

Parameters

RichText $pValue

Return Value

Comment

string getWidth()

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

Return Value

string

Comment setWidth(string $width)

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

Parameters

string $width

Return Value

Comment

string getHeight()

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

Return Value

string

Comment setHeight(string $value)

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

Parameters

string $value

Return Value

Comment

string getMarginLeft()

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

Return Value

string

Comment setMarginLeft(string $value)

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

Parameters

string $value

Return Value

Comment

string getMarginTop()

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

Return Value

string

Comment setMarginTop(string $value)

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

Parameters

string $value

Return Value

Comment

bool getVisible()

Is the comment visible by default?

Return Value

bool

Comment setVisible(bool $value)

Set comment default visibility.

Parameters

bool $value

Return Value

Comment

Color getFillColor()

Get fill color.

Return Value

Color

Comment setAlignment(string $alignment)

Set Alignment.

Parameters

string $alignment see Style\Alignment::HORIZONTAL_*

Return Value

Comment

string getAlignment()

Get Alignment.

Return Value

string

string getHashCode()

Get hash code.

Return Value

string Hash code

__clone()

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

string __toString()

Convert to string.

Return Value

string