Class: Heading

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

Class Heading

Class Overview

Heading class extends Paragraph class.

Located in /content/body/text/Heading.php [line 62]

DOMElement
   |
   --ODPElement
      |
      --Paragraph
         |
         --Heading

Author(s):

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

Information Tags:

Version:	Release: @package_version@
Copyright:	Copyright in 2006, 2007 by The OpenDocumentPHP Team
Link:	http://opendocumentphp.org
Since:	0.5.0 - 08. Feb. 2007
License:	GNU General Public License 2.0.

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From Paragraph

Paragraph::__construct()

Constructor method.

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()

Inherited From ODPElement

ODPElement::__construct()

Constructor.

ODPElement::appendChild()

Set attribute with namespace.

ODPElement::getAttributeNS()

Retrieve an attribute with namespace, tag and value.

ODPElement::getChildNS()

Retrieve a child by its namespace and tag from the current node.

ODPElement::getDrawAttribute()

Retrieve a draw attribute of the current element.

ODPElement::getElement()

Return this element as uncovered DOMElement.

ODPElement::getElementByTagNameNS()

Retrieve (first) element by given tagname and namespace.

ODPElement::getElementsByTagNameNS()

Retrieve elements by given tagname and namespace.

ODPElement::getStyleAttribute()

Retrieve a style attribute of the current element.

ODPElement::hasAttributeNS()

Check if this element has an attribute with given namespace and tagname.

ODPElement::hasChildNS()

Check if the current element has a child $tag with $namespace.

ODPElement::putAttributeNS()

Put an attribute with namespace, tag and value.

ODPElement::putDrawAttribute()

Put (set with remove old) a draw attribute to the current ODPElement.

ODPElement::putFOAttribute()

Put (set with remove old) a FO attribute to the current ODPElement.

ODPElement::putStyleAttribute()

Put (set with remove old) a sytle attribute to the current ODPElement.

ODPElement::removeAttributeNS()

Set attribute with namespace.

ODPElement::setAttributeNS()

Set attribute with namespace.

ODPElement::setManifestAttribute()

Set a Manifest attribute to the current ODPElement.

Inherited From DOMElement (Internal Class)

constructor __construct ( )

appendChild ( )

C14N ( )

C14NFile ( )

cloneNode ( )

compareDocumentPosition ( )

getAttribute ( )

getAttributeNode ( )

getAttributeNodeNS ( )

getAttributeNS ( )

getElementsByTagName ( )

getElementsByTagNameNS ( )

getFeature ( )

getNodePath ( )

getUserData ( )

hasAttribute ( )

hasAttributeNS ( )

hasAttributes ( )

hasChildNodes ( )

insertBefore ( )

isDefaultNamespace ( )

isEqualNode ( )

isSameNode ( )

isSupported ( )

lookupNamespaceUri ( )

lookupPrefix ( )

normalize ( )

removeAttribute ( )

removeAttributeNode ( )

removeAttributeNS ( )

removeChild ( )

replaceChild ( )

setAttribute ( )

setAttributeNode ( )

setAttributeNodeNS ( )

setAttributeNS ( )

setIdAttribute ( )

setIdAttributeNode ( )

setIdAttributeNS ( )

setUserData ( )

[ Top ]

Method Summary

Heading	__construct()	Constructor method.
int	getHeadingLevel()	Retrieve heading level ('text:outline-level') attribute.
void	getIsListHeader()
void	getRestartNumbering()
void	getStartValue()
void	setHeadingLevel()	Set heading level ('text:outline-level') attribute.
void	setIsListHeader()	Supress Header Numbering.
void	setRestartNumbering()
void	setStartValue()
void	unSetIsListHeader()
void	unSetRestartNumbering()

[ Top ]

Methods

Constructor __construct [line 69]

Heading __construct(
[
$elem = null] 
)

Constructor method.

Parameters:

$elem:

Information Tags:

Since:

0.5.2 - 26. Feb. 2007

Redefinition of:

Paragraph::__construct(): Constructor method.

[ Top ]

getHeadingLevel [line 106]

int getHeadingLevel(
)

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

API Tags:

Return:	The heading/outline level as a positive integer.
Access:	public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

getIsListHeader [line 222]

void getIsListHeader(
)

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

getRestartNumbering [line 144]

void getRestartNumbering(
)

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

getStartValue [line 181]

void getStartValue(
)

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

setHeadingLevel [line 88]

void setHeadingLevel(
int
$level 
)

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

Parameters:

int

$level:

A positive integer for the new heading level.

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

setIsListHeader [line 202]

void setIsListHeader(
)

Supress Header Numbering.

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

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

setRestartNumbering [line 124]

void setRestartNumbering(
)

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

setStartValue [line 163]

void setStartValue(

$startValue 
)

Parameters:

$startValue:

API Tags:

Access:

public

Information Tags:

Todo:	Use Validate class here.
Since:	0.5.0 - 08. Feb. 2007

[ Top ]

unSetIsListHeader [line 212]

void unSetIsListHeader(
)

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

unSetRestartNumbering [line 134]

void unSetRestartNumbering(
)

API Tags:

Access:

public

Information Tags:

Since:

0.5.0 - 08. Feb. 2007

[ Top ]

Documentation generated on Wed, 18 Jun 2008 06:29:08 +0200 by phpDocumentor 1.3.2

	OpenDocumentPHP content_body_text

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