TPTP 4.6.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.core.internal
Class DDocument

java.lang.Object
  extended by org.eclipse.tptp.platform.report.core.internal.DItem
      extended by org.eclipse.tptp.platform.report.core.internal.DItemContainer
          extended by org.eclipse.tptp.platform.report.core.internal.DAbstractParagraph
              extended by org.eclipse.tptp.platform.report.core.internal.DDocument
All Implemented Interfaces:
IDAlignment, IDDocument, IDItem, IDObject, IDTaggedItem, org.eclipse.tptp.platform.report.core.provisional.IChart

Deprecated. As of TPTP 4.5.0, use the TPTP Business Intelligence and Reporting Tools (BIRT) reporting infrastructure (org.eclipse.tptp.platform.report.birt).

public class DDocument
extends DAbstractParagraph
implements IDDocument, org.eclipse.tptp.platform.report.core.provisional.IChart

A DDocument is the class to use to create any document. This item is generally the root item of a IDItem hierarchy. You can add a title which will be used by the drivers to indicate the document which they are currently processing or displaying (Printer Job, tiltle window). DDocument support alignment,all the items added to the paragraph will be displayed by the driver in the specified alignment.

See Also:
IDAlignment

Field Summary
 
Fields inherited from interface org.eclipse.tptp.platform.report.core.internal.IDAlignment
BOTTOM, CENTER, DEFAULT_ALIGN, HCENTER, LAST, LEFT, NO_WORD_WRAP, RIGHT, ROTCCW90, ROTCW90, TOP, VCENTER, VERTICAL
 
Constructor Summary
DDocument()
          Deprecated. Creates a DDocument.
DDocument(int align)
          Deprecated. Creates a DDocument with an alignment.
DDocument(java.lang.String tag, java.lang.String title)
          Deprecated. Creates a DDocument with a tag and a title and a default alignment.
DDocument(java.lang.String tag, java.lang.String title, int align)
          Deprecated. Creates a DDocument with a tag, a title and an alignment.
 
Method Summary
 IDItem getDocument()
          Deprecated.  
 java.lang.String getTag()
          Deprecated. Access method for the tag property.
 java.lang.String getTitle()
          Deprecated. Access method for the title property.
 void setTag(java.lang.String aTag)
          Deprecated. Sets the value of the tag property.
 void setTitle(java.lang.String aTitle)
          Deprecated. Sets the value of the title property.
 
Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DAbstractParagraph
addAlignment, getAlignment, getAlignment, haveAlignment, haveOneOfAlignment, removeAlignment, setAlignment
 
Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItemContainer
clear, getChildCount, getChildOfClass, getChildPosition, getChildrenOfClass, getFirstChild, getLastChild, insertChild, isContainer, removeChild
 
Methods inherited from class org.eclipse.tptp.platform.report.core.internal.DItem
addChild, getAppliedStyle, getIterator, getNext, getParent, getRoot, getStyle, setNext, setParent, setStyle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.eclipse.tptp.platform.report.core.internal.IDItem
addChild, clear, getAppliedStyle, getChildCount, getChildPosition, getFirstChild, getIterator, getLastChild, getNext, getParent, getRoot, getStyle, insertChild, isContainer, removeChild, setNext, setParent, setStyle
 

Constructor Detail

DDocument

public DDocument(java.lang.String tag,
                 java.lang.String title,
                 int align)
Deprecated. 
Creates a DDocument with a tag, a title and an alignment.

Parameters:
tag - of the DDocument
title - of the DDocument
align - is the alignment
See Also:
IDAlignment

DDocument

public DDocument(int align)
Deprecated. 
Creates a DDocument with an alignment. The tag is documentdef by default and the title is unnamed.

See Also:
IDAlignment

DDocument

public DDocument(java.lang.String tag,
                 java.lang.String title)
Deprecated. 
Creates a DDocument with a tag and a title and a default alignment.

Parameters:
tag - of the DDocument
title - of the DDocument

DDocument

public DDocument()
Deprecated. 
Creates a DDocument. The tag is documentdef by default and the title is unnamed.

Method Detail

getTitle

public java.lang.String getTitle()
Deprecated. 
Access method for the title property.

Specified by:
getTitle in interface IDDocument
Returns:
the current value of the title property

setTitle

public void setTitle(java.lang.String aTitle)
Deprecated. 
Sets the value of the title property. If the value is null the document is named unnamed automatically.

Specified by:
setTitle in interface IDDocument
Parameters:
aTitle - the new value of the title property

getTag

public java.lang.String getTag()
Deprecated. 
Access method for the tag property.

Specified by:
getTag in interface IDTaggedItem
Returns:
the current value of the tag property

setTag

public void setTag(java.lang.String aTag)
Deprecated. 
Sets the value of the tag property. If the value is null the document is named documentdef automatically.

Specified by:
setTag in interface IDTaggedItem
Parameters:
aTag - the new value of the tag property

getDocument

public IDItem getDocument()
Deprecated. 
Specified by:
getDocument in interface IDDocument
Returns:
this
See Also:
org.eclipse.tptp.platform.report.core.provisional.internal.IDDocument#getDocument()

TPTP 4.6.0 Platform Project
Internal API Specification