org.odftoolkit.simple.draw
Interface TextboxContainer

All Superinterfaces:
FrameContainer
All Known Implementing Classes:
AbstractTextboxContainer, Paragraph, Slide

public interface TextboxContainer
extends FrameContainer

TextboxContainer is a container which maintains TextBox(s) as element(s). TextBox(s) can be added, removed and iterated in this container.

Since:
0.5

Method Summary
 Textbox addTextbox()
          Add a text box
 Textbox addTextbox(FrameRectangle position)
          Add a text box with a specific size at a specific position
 Textbox getTextboxByName(String name)
          Return a text box whose name is a given value.
 List<Textbox> getTextboxByUsage(PresentationDocument.PresentationClass usage)
          This method is only useful in presentation slide.
 Iterator<Textbox> getTextboxIterator()
          Return an Iterator of the text objects in this container.
 boolean removeTextbox(Textbox box)
          Remove the text box
 
Methods inherited from interface org.odftoolkit.simple.draw.FrameContainer
getFrameContainerElement
 

Method Detail

addTextbox

Textbox addTextbox()
Add a text box

Returns:
the object of text box

addTextbox

Textbox addTextbox(FrameRectangle position)
Add a text box with a specific size at a specific position

Parameters:
position - - the rectangle (position and size) of this text box
Returns:
the object of text box

removeTextbox

boolean removeTextbox(Textbox box)
Remove the text box

Parameters:
box - - the instance of text box
Returns:
true if success, false if fails

getTextboxIterator

Iterator<Textbox> getTextboxIterator()
Return an Iterator of the text objects in this container.

Returns:
an Iterator of the text objects in this container

getTextboxByName

Textbox getTextboxByName(String name)
Return a text box whose name is a given value.

Parameters:
name - - the name of the text box
Returns:
a text box whose name is a given value

getTextboxByUsage

List<Textbox> getTextboxByUsage(PresentationDocument.PresentationClass usage)
This method is only useful in presentation slide.

This method will return a list of text boxs by the usage in presentation slides.

Parameters:
usage - - the usage description
Returns:
a list of text box Null will be returned if the owner document is not a presentation


Copyright © 2010-2017 The Apache Software Foundation. All Rights Reserved.