TPTP 4.2.0 Platform Project
Internal API Specification

org.eclipse.tptp.platform.report.core.internal
Interface IDItem

All Superinterfaces:
IDObject
All Known Subinterfaces:
IDBasicItem, IDDocument, IDParagraphItem, IDRenderable, IDSizeableItem, IDTaggedItem, IDTextualItem
All Known Implementing Classes:
DAccessibilityDesc, DBorder, DCellText, DCoordAbstract, DData, DDocument, DGraphic, DImage, DIndex, DIndexEntry, DItem, DLine, DLink, DList, DPageBreak, DPageCounter, DParagraph, DPopup, DSection, DSummary, DTable, DTag, DText, DTitle

public interface IDItem
extends IDObject

Provides an interface for all items in a JScrib document except Colors, Fonts and Styles.


Method Summary
 boolean addChild(IDItem item)
          Adds a child item after the last child.
 void clear()
          Clears the resources kept by the item.
 IDStyle getAppliedStyle()
          Returns the style to applied on this item, might be getStyle() or one of parent's style if getStyle returns null.
 int getChildCount()
          Returns the item child number.
 int getChildPosition(IDItem i)
          Returns the child item position in the list.
 IDItem getFirstChild()
          Returns the first child of the item.
 IDItemIterator getIterator()
          Returns the item iterator.
 IDItem getLastChild()
          Returns the last child of the item.
 IDItem getNext()
          Returns the next item.
 IDItem getParent()
          Returns the parent of the item.
 IDItem getRoot()
          Returns the current document.
 IDStyle getStyle()
          Returns the item style.
 boolean insertChild(IDItem item, IDItem after)
          Inserts the child 'item' after the item 'after' if acceptChild(item,after) returns true.
 boolean isContainer()
          Returns true if the item is a container.
 boolean removeChild(IDItem item)
          Removes the child 'item'.
 void setNext(IDItem i)
          Sets the next item to 'i'.
 void setParent(IDItem p)
          Sets the parent item to 'p'.
 void setStyle(IDStyle style)
          Sets the item style to 'style'.
 

Method Detail

addChild

public boolean addChild(IDItem item)
Adds a child item after the last child.


clear

public void clear()
Clears the resources kept by the item.


getChildCount

public int getChildCount()
Returns the item child number.


getChildPosition

public int getChildPosition(IDItem i)
Returns the child item position in the list.


getRoot

public IDItem getRoot()
Returns the current document.


getFirstChild

public IDItem getFirstChild()
Returns the first child of the item.


getIterator

public IDItemIterator getIterator()
Returns the item iterator.


getLastChild

public IDItem getLastChild()
Returns the last child of the item.


getNext

public IDItem getNext()
Returns the next item.


getParent

public IDItem getParent()
Returns the parent of the item.


getAppliedStyle

public IDStyle getAppliedStyle()
Returns the style to applied on this item, might be getStyle() or one of parent's style if getStyle returns null.

See Also:
getStyle()

getStyle

public IDStyle getStyle()
Returns the item style.


insertChild

public boolean insertChild(IDItem item,
                           IDItem after)
Inserts the child 'item' after the item 'after' if acceptChild(item,after) returns true.

Parameters:
after - item after which child should be added

isContainer

public boolean isContainer()
Returns true if the item is a container.


removeChild

public boolean removeChild(IDItem item)
Removes the child 'item'.


setNext

public void setNext(IDItem i)
Sets the next item to 'i'.

Parameters:
i - next item

setParent

public void setParent(IDItem p)
Sets the parent item to 'p'.

Parameters:
p - parent item

setStyle

public void setStyle(IDStyle style)
Sets the item style to 'style'.

Parameters:
style - item style

TPTP 4.2.0 Platform Project
Internal API Specification