OpenDocument
[ class tree: OpenDocument ] [ index: OpenDocument ] [ all elements ]

Class: OpenDocument_StyledElement

Source Location: /OpenDocument-0.2.1/OpenDocument/StyledElement.php

Class Overview

OpenDocument_Element
   |
   --OpenDocument_StyledElement

Base class for elements with styles


Author(s):

Version:

  • 0.1.0

Variables

Methods


Child classes:

Inherited Variables

Inherited Methods


Class Details

[line 42]
Base class for elements with styles


[ Top ]


Class Variables

$style =

[line 49]

Style information
  • Access: protected



[ Top ]

$styleNameMaxNumber =  0

[line 64]

Style name suffix max value
  • Access: protected

Type:   integer


[ Top ]



Method Detail

__construct (Constructor)   [line 86]

OpenDocument_StyledElement __construct( $node, OpenDocument_Document $document)

Constructor
  • Access: public

Overridden in child classes as:

OpenDocument_Element_Paragraph::__construct()
Constructor
OpenDocument_Element_Hyperlink::__construct()
Constructor
OpenDocument_Element_Heading::__construct()
Constructor

Overrides OpenDocument_Element::__construct() (Constructor)

Parameters:

DOMNode   $node     DOM node to create element for
OpenDocument_Document   $document     Document object the element is being created for

[ Top ]

applyStyle   [line 171]

void applyStyle( string $name, mixed $value)

Apply style information
  • Access: public

Parameters:

string   $name     Name of style property ('fo:font-weight')
mixed   $value     Value for property

[ Top ]

generateStyleName   [line 77]

string generateStyleName( )

Generate new style name
  • Return: New style name
  • Abstract:
  • Access: public

Overridden in child classes as:

OpenDocument_Element_Paragraph::generateStyleName()
Generate element new style name
OpenDocument_Element_Hyperlink::generateStyleName()
Generate element new style name
OpenDocument_Element_Span::generateStyleName()
Generate new style name
OpenDocument_Element_Heading::generateStyleName()
Generate element new style name

[ Top ]

getStyle   [line 116]

array getStyle( array $properties)

Get style information
  • Return: Key-value array of properties and their values
  • See: OpenDocument::getStyle()
  • Access: public

Parameters:

array   $properties     Array of namespace-prefixed properties to retrieve.

[ Top ]

getStyleName   [line 126]

string getStyleName( )

Get style name
  • Return: Get name of style
  • Access: public

[ Top ]

getStyleNameMaxNumber   [line 146]

integer getStyleNameMaxNumber( )

Get style name suffix max value
  • Access: public

[ Top ]

getStyleNamePrefix   [line 136]

string getStyleNamePrefix( )

Get style name prefix
  • Return: Prefix for style name
  • Access: public

[ Top ]

setStyleNameMaxNumber   [line 158]

void setStyleNameMaxNumber( integer $number)

Set style name suxxif max value
  • Access: public

Parameters:

integer   $number     Maxium style number

[ Top ]

__get   [line 99]

mixed __get( string $name)

Magic method: Get a property value.
  • Return: Value of property.
  • Access: public

Overridden in child classes as:

OpenDocument_Element_Hyperlink::__get()
Get element property
OpenDocument_Element_Heading::__get()
Get element properties

Parameters:

string   $name     Name of property to retrieve ('style')

[ Top ]


Documentation generated on Tue, 23 Oct 2012 12:00:09 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.