word.api.interfaces.IHasElement Maven / Gradle / Ivy
The newest version!
package word.api.interfaces;
/**
* @author leonardo_correa
*
*
* This interface is implemented by elements that can accept others elements to be processed and inserted inside.
* Eg.: Paragraph can have an Image inside.
*
*
*
* IDocument myDoc = new Document2004();
* myDoc.getBody().addEle(new Paragraph("This document is an example of paragraph: " + new Image("/server_root/dtpick.gif", ImageLocation.FULL_LOCAL_PATH).getContent()));
*
* The Element Document is a good example. It HAS TO accepts others elements:
* *
*
* IDocument myDoc = new Document2004();
* myDoc.getBody().addEle(new Heading1("My Header1"));
*
*
*
*/
public interface IHasElement extends IElement{
/**
* The content of the Element will be evaluated inside the object.
*
* This is an alias to 'getBody().addEle'
*
*/
public void addEle(IElement e);
/**
* In order to give flexibility, String methods was added.
* Imagine you need to add an element which hasn't been implemented, for example, Graphs.
* You know how to generate the XML to generate a Graph because you figured it out by yourself.
* In this case you could do this:
*
* IDocument myDoc = new Document2004();
* String myXml = myMethodToReturnXML(); //This method return the XML to generate my graph - you have to write this one
* myDoc.getBody().addEle(new Paragraph("This is a my graph: " + myXml));
*
*
* This is an alias to 'getBody().addEle'
*
*/
public void addEle(String str);
}