Class: Heading

Source Location: /content/body/text/Heading.php

Class Overview

Fragment
   |
   --ElementFragment
      |
      --Paragraph
         |
         --Heading

Heading class extends Paragraph class.

Author(s):

Norman Markgraf (nmarkgraf(at)user.sourceforge.net)

Version:

$Revision: 145 $

Copyright:

Methods

Inherited Constants

Inherited Variables

Class: Fragment

Fragment::$domFragment
Fragment::$root
Fragment::$xpath

Inherited Methods

Class: Paragraph

Paragraph::append(): Append a text node or a DOMElement as a child to the current paragraph node.
Paragraph::getClassNames()
Paragraph::getCondStyleName()
Paragraph::getId()
Paragraph::getStyleName()
Paragraph::setClassNames()
Paragraph::setCondStyleName()
Paragraph::setId()
Paragraph::setStyleName()
Paragraph::__setRoot(): Set element to 'text:p'.

Class: ElementFragment

ElementFragment::__construct(): Constructor method.
ElementFragment::getAttributeNS(): Retreive an attribute by namespace and tag.
ElementFragment::getElement(): Retrieve the current Class as DOMElement.
ElementFragment::setAttributeNS(): Set an attribute with namespace, tag and value.
ElementFragment::__setRoot(): Set the $root attribute correctly.

Class: Fragment

Fragment::__construct(): Constructor method.
Fragment::appendChild(): Set attribute with namespace.
Fragment::createDCElement(): Create an DOMElement in the DC namespace with tag $tag.
Fragment::createMetaElement(): Create an DOMElement in the Meta namespace with tag $tag.
Fragment::createOfficeElement(): Create an DOMElement in the Office namespace with tag $tag.
Fragment::createStyleElement(): Create an DOMElement in the Meta namespace with tag $tag.
Fragment::getChild(): Retrieve a child by its namespace and tag from the current node.
Fragment::getDocumentFragment(): Returns the root DOMElement of this DOM fragment.
Fragment::getTag()
Fragment::hasChild(): Check if the current element has a child $tag with $namespace.
Fragment::initXpath(): Initialize xpath. You must do this before using xpath.
Fragment::setTag(): Set (which means append or replace an existing node) a new node.

Class Details

[line 35]
Heading class extends Paragraph class.

Tags:

author:	Norman Markgraf (nmarkgraf(at)user.sourceforge.net)
version:	$Revision: 145 $
copyright:	Copyright in 2006, 2007 by The OpenDocumentPHP Team
since:	0.5.0 - 02.08.2007
license:	GNU General Public License 2.0.

[ Top ]

Class Methods

method getHeadingLevel [line 71]

int getHeadingLevel(
)

Retrieve heading level ('text:outline-level') attribute.

Tags:

return:	The heading/outline level as a positive integer.
since:	0.5.0 - 08.02.2007
access:	public

[ Top ]

method getIsListHeader [line 170]

void getIsListHeader(
)

Tags:

since:	0.5.0 - 08.02.2007
access:	public

[ Top ]

method getRestartNumbering [line 103]

void getRestartNumbering(
)

Tags:

since:	0.5.0 - 08.02.2007
access:	public

[ Top ]

method getStartValue [line 135]

void getStartValue(
)

Tags:

since:	0.5.0 - 08.02.2007
access:	public

[ Top ]

method setHeadingLevel [line 55]

void setHeadingLevel(
int
$level)

Set heading level ('text:outline-level') attribute.

Tags:

since:	0.5.0 - 08.02.2007
access:	public

Parameters:

int

$level

A positive integer for the new heading level.

[ Top ]

method setIsListHeader [line 154]

void setIsListHeader(
)

Supress Header Numbering.

It is sometimes desired to have a specific heading which should not be numbered.

Tags:

since:	0.5.0 - 08.02.2007
access:	public

[ Top ]

method setRestartNumbering [line 87]

void setRestartNumbering(
)

Tags:

since:	0.5.0 - 08.02.2007
access:	public

[ Top ]

method setStartValue [line 119]

void setStartValue(

$startValue)

Tags:

since:	0.5.0 - 08.02.2007
access:	public

Parameters:

$startValue

[ Top ]

method unSetIsListHeader [line 162]

void unSetIsListHeader(
)

Tags:

since:	0.5.0 - 08.02.2007
access:	public

[ Top ]

method unSetRestartNumbering [line 95]

void unSetRestartNumbering(
)

Tags:

since:	0.5.0 - 08.02.2007
access:	public

[ Top ]

method __setRoot [line 42]

void __setRoot(
)

Set element to 'text:h'.

Tags:

since:	0.5.0 - 08.02.2007
access:	protected

Overrides Paragraph::__setRoot() (Set element to 'text:p'.)

[ Top ]

Documentation generated on Tue, 12 Jun 2007 09:59:58 +0200 by phpDocumentor 1.3.2