Documentation

Frame extends AbstractStyle

in package

• Application

Frame defines the size and position of an object.

Tags

since

0.12.0

todo

Make existing style (image, textbox, etc) use this style

Table of Contents

Constants

POS_ABSOLUTE  = 'absolute'

General positioning options.

POS_BOTTOM  = 'bottom'

POS_CENTER  = 'center'

Horizontal/vertical value.

POS_INSIDE  = 'inside'

POS_LEFT  = 'left'

POS_OUTSIDE  = 'outside'

POS_RELATIVE  = 'relative'

POS_RELTO_BMARGIN  = 'bottom-margin-area'

POS_RELTO_CHAR  = 'char'

POS_RELTO_COLUMN  = 'column'

POS_RELTO_IMARGIN  = 'inner-margin-area'

POS_RELTO_LINE  = 'line'

POS_RELTO_LMARGIN  = 'left-margin-area'

POS_RELTO_MARGIN  = 'margin'

Position relative to.

POS_RELTO_OMARGIN  = 'outer-margin-area'

POS_RELTO_PAGE  = 'page'

POS_RELTO_RMARGIN  = 'right-margin-area'

POS_RELTO_TEXT  = 'text'

POS_RELTO_TMARGIN  = 'top-margin-area'

POS_RIGHT  = 'right'

POS_TOP  = 'top'

UNIT_PT  = 'pt'

Length unit.

UNIT_PX  = 'px'

WRAP_BEHIND  = 'behind'

WRAP_INFRONT  = 'infront'

WRAP_INLINE  = 'inline'

Wrap type.

WRAP_SQUARE  = 'square'

WRAP_THROUGH  = 'through'

WRAP_TIGHT  = 'tight'

WRAP_TOPBOTTOM  = 'topAndBottom'

Properties

$aliases  : array<string|int, mixed>

Aliases.

$index  : null|int

Index number in Style collection for named style.

$styleName  : string|null

Style name.

$alignment  : string

$height  : float|int

Height.

$hPos  : string

Horizontal position.

$hPosRelTo  : string

Horizontal position relative to.

$isAuto  : bool

Is this an automatic style? (Used primarily in OpenDocument driver).

$left  : float|int

Leftmost (horizontal) position.

$pos  : string

Position type: absolute|relative.

$position  : int

Vertically raised or lowered text.

$top  : float|int

Topmost (vertical) position.

$unit  : string

Unit.

$vPos  : string

Vertical position.

$vPosRelTo  : string

Vertical position relative to.

$width  : float|int

Width.

$wrap  : string

Wrap type.

$wrapDistanceBottom  : float

Bottom wrap distance.

$wrapDistanceLeft  : float

Left wrap distance.

$wrapDistanceRight  : float

Right wrap distance.

$wrapDistanceTop  : float

Top wrap distance.

Methods

__construct()  : mixed

Create a new instance.

getAlignment()  : string

getChildStyleValue()  : mixed

Return style value of child style object, e.g. `left` from `Indentation` child style of `Paragraph`.

getHeight()  : float|int

Get height.

getHPos()  : string

Get horizontal position.

getHPosRelTo()  : string

Get horizontal position relative to.

getIndex()  : null|int

Get index number.

getLeft()  : float|int

Get left.

getPos()  : string

Get position type.

getPosition()  : int

Get position.

getStyleName()  : string|null

Get style name.

getTop()  : float|int

Get topmost position.

getUnit()  : string

Get unit.

getVPos()  : string

Get vertical position.

getVPosRelTo()  : string

Get vertical position relative to.

getWidth()  : float|int

Get width.

getWrap()  : string

Get wrap type.

getWrapDistanceBottom()  : float

Get bottom distance from text wrap.

getWrapDistanceLeft()  : float

Get left distance from text wrap.

getWrapDistanceRight()  : float

Get right distance from text wrap.

getWrapDistanceTop()  : float

Get top distance from text wrap.

isAuto()  : bool

Get is automatic style flag.

setAlignment()  : self

setAuto()  : self

Set is automatic style flag.

setHeight()  : self

Set height.

setHPos()  : self

Set horizontal position.

setHPosRelTo()  : self

Set horizontal position relative to.

setIndex()  : self

Set index number.

setLeft()  : self

Set left.

setPos()  : self

Set position type.

setPosition()  : self

Set position.

setStyleByArray()  : self

Set style by using associative array.

setStyleName()  : self

Set style name.

setStyleValue()  : self

Set style value template method.

setTop()  : self

Set topmost position.

setUnit()  : self

Set unit.

setVPos()  : self

Set vertical position.

setVPosRelTo()  : self

Set vertical position relative to.

setWidth()  : self

Set width.

setWrap()  : self

Set wrap type.

setWrapDistanceBottom()  : self

Set bottom distance from text wrap.

setWrapDistanceLeft()  : self

Set left distance from text wrap.

setWrapDistanceRight()  : self

Set right distance from text wrap.

setWrapDistanceTop()  : self

Set top distance from text wrap.

setBoolVal()  : bool

Set bool value.

setEnumVal()  : mixed

Set enum value.

setFloatVal()  : null|float

Set float value: Convert string that contains only numeric into float.

setIntVal()  : null|int

Set integer value: Convert string that contains only numeric into integer.

setNonEmptyVal()  : string

Set default for null and empty value.

setNumericVal()  : null|float|int

Set numeric value.

setObjectVal()  : mixed

Set object value.

setPairedVal()  : self

Set $property value and set $pairProperty = false when $value = true.