com.aspose.pdf

Field Detail

• document

  public com.aspose.pdf.engine.IPdfDocument document

  For internal usage only.

Constructor Detail

• OutlineItemCollection

  public OutlineItemCollection(com.aspose.pdf.engine.data.IPdfObject outline)

  Initializes new instance of this class using internal engine outline entry object.

  Parameters:

  outline - Internal engine object of outline entry.

• OutlineItemCollection

  public OutlineItemCollection(OutlineCollection outlines)

  Initializes outline item instance using root hierarchy object.

  Parameters:

  outlines - Outlune collection.

Method Detail

• getEngineDict

  public com.aspose.pdf.engine.data.IPdfDictionary getEngineDict()

  Internal only

  Returns:

  IPdfDictionary object

• getEngineObj

  public com.aspose.pdf.engine.data.IPdfObject getEngineObj()

  Internal only

  Returns:

  IPdfObject object

• getTitle

  public String getTitle()

  Gets the title for this outline item.

  Returns:

  String value

• setTitle

  public void setTitle(String value)

  Sets the title for this outline item.

  Parameters:

  value - String value

• getDestination

  public IAppointment getDestination()

  Gets the destination for this outline item.

  Returns:

  IAppointment value

• setDestination

  public void setDestination(IAppointment value)

  Sets the destination for this outline item.

  Parameters:

  value - IAppointment value

• getAction

  public PdfAction getAction()

  Gets the action for this outline item.

  Returns:

  PdfAction value

• setAction

  public void setAction(PdfAction value)

  Sets the action for this outline item.

  Parameters:

  value - PdfAction value

• getColor

  public Color getColor()

  Gets the color for the title text of this outline item.

  Returns:

  Color value

• setColor

  public void setColor(Color value)

  Sets the color for the title text of this outline item.

  Parameters:

  value - Color object

• getItalic

  public boolean getItalic()

  Gets italic flag for the title text of this outline item

  Returns:

  boolean value

• setItalic

  public void setItalic(boolean value)

  Sets italic flag for the title text of this outline item

  Parameters:

  value - boolean value

• getBold

  public boolean getBold()

  Gets bold flag for the title text of this outline item

  Returns:

  boolean value

• setBold

  public void setBold(boolean value)

  Sets bold flag for the title text of this outline item

  Parameters:

  value - boolean value

• getFirst

  public OutlineItemCollection getFirst()

  Gets the outline item representing the first top-level item in the outline hierarchy.

  Returns:

  OutlineItemCollection value

• getLast

  public OutlineItemCollection getLast()

  Gets the outline item representing the last top-level item in the outline hierarchy.

  Returns:

  OutlineItemCollection value

• getPrev

  public OutlineItemCollection getPrev()

  Gets the outline item representing previous item relatively this item in the outline hierarchy.

  Returns:

  OutlineItemCollection value

• getNext

  public OutlineItemCollection getNext()

  Gets the outline item representing next item relatively this item in the outline hierarchy.

  Returns:

  OutlineItemCollection value

• hasNext

  public final boolean hasNext()

  Check if outline item representing next item relatively this item in the outline hierarchy.

  Returns:

  boolean value

• next

  public OutlineItemCollection next()

• getParent

  public Outlines getParent()

  Gets the parent object of this outline item in the outline hierarchy.

  Returns:

  Object value

• getVisibleCount

  public int getVisibleCount()

  Gets the total number of outline items at all levels in the document outline hierarchy.

  Specified by:

  getVisibleCount in class Outlines

  Returns:

  int value

• isSynchronized

  public boolean isSynchronized()

  Gets the value indicating whether access to this collection is synchronized (thread safe).

  Returns:

  boolean value

• getSyncRoot

  public Object getSyncRoot()

  Gets the object that can be used to synchronize access to this collection.

  Returns:

  Object value

• isReadOnly

  public boolean isReadOnly()

  Gets a value indicating whether the collection is read-only.

  Specified by:

  isReadOnly in class Outlines

  Returns:

  boolean value

• getOpen

  public boolean getOpen()

  Get open status (true/false) for outline item.

  Returns:

  boolean value

• setOpen

  public void setOpen(boolean value)

  Sets open status (true/false) for outline item.

  Parameters:

  value - boolean value

• delete

  public void delete()

  Deletes this outline item from the document outline hierarchy.

• delete

  public void delete(String name)

  Deletes outline entry with specified name from the document outline hierarchy.

  Parameters:

  name - Title of outline entry will be deleted.

• copyTo

  public void copyTo(OutlineItemCollection[] array,
                     int index)

  Copies the outline entries to an System.Array, starting at a particular System.Array index.

  Specified by:

  copyTo in class Outlines

  Parameters:

  array - The one-dimensional System.Array that is the destination. Must have zero-based indexing.

  index - The zero-based index in array at which copying begins.

• iterator

  public Iterator<OutlineItemCollection> iterator()

  Returns an enumerator that iterates through the collection.

  Specified by:

  iterator in interface Iterable<OutlineItemCollection>

  Specified by:

  iterator in class Outlines

  Returns:

  An System.Collections.IEnumerator object that can be used to iterate through the collection.

• add

  public void add(OutlineItemCollection outline)

  Adds outline item to collection.

  Specified by:

  add in class Outlines

  Parameters:

  outline - The outline item to be added.

• insert

  public void insert(int index,
                     OutlineItemCollection outline)

  Inserts the outline item into collection at the specified place.

  Parameters:

  index - The index specifying place for inserting.

  outline - The outline item should be inserted.

• clear

  public void clear()

  Clears all items from the collection.

  Specified by:

  clear in class Outlines

• contains

  public boolean contains(OutlineItemCollection item)

  Not supported yet.

  Always throws NotImplementedException

  Specified by:

  contains in class Outlines

  Parameters:

  item - The object to locate in the collection

  Returns:

  boolean value

• remove

  public boolean remove(OutlineItemCollection item)

  Not supported yet.

  Always throws NotImplementedException

  Specified by:

  remove in class Outlines

  Parameters:

  item - OutlineItemCollection instance

  Returns:

  boolean value

• remove

  public final void remove(int index)

  Remove item by index.

  Parameters:

  index - Index of item to be deleted.

• size

  public int size()

  Count of collection items. Please dont confuse with VisibleCount: VisibleCount gets number of visible outline item on all levels.

  Specified by:

  size in class Outlines

• get_Item

  public OutlineItemCollection get_Item(int index)

  Gets outline item from the collection using index.

  Parameters:

  index - Index within the collection.

  Returns:

  OutlineItemCollection object.

• getLevel

  public int getLevel()

  Gets hierarchy level of outline item.

  Returns:

  int value