|
| |
|
| java.lang.Object
 com.xoetrope.export.Exporter
All known Subclasses: com.xoetrope.export.xl.XLExporter, com.xoetrope.export.pdf.PdfExporter, com.xoetrope.export.html.HTMLExporter,
| Exporter | | abstract public class Exporter (Code) | | Abstract class for exporting to different formats.
Copyright (c) Xoetrope Ltd., 2001-2006, This software is licensed under
the GNU Public License (GPL), please see license.txt for more details. If
you make commercial use of this software you must purchase a commercial
license from Xoetrope.
$Revision: 1.8 $
|
| Constructor Summary | |
| public | Exporter(XProject project, Object instance)
|
| HTML_EXPORTER | | final public static int HTML_EXPORTER(Code) | | |
| PDF_EXPORTER | | final public static int PDF_EXPORTER(Code) | | |
| XL_EXPORTER | | final public static int XL_EXPORTER(Code) | | |
| currentProject | | protected XProject currentProject(Code) | | |
| evaluator | | protected XDefaultAttributeEvaluator evaluator(Code) | | |
| exportType | | protected int exportType(Code) | | |
| Exporter | | public Exporter(XProject project, Object instance)(Code) | | Create a new exporter and create a Vector for the export blocks which will
be added
Parameters:
instance - the current page or object that provides the methods or fields used in the evaluation |
| addBlock | | public void addBlock(Block block)(Code) | | Append a new Block Object to the export Vector
Parameters:
blockExport - the Block object to be appended |
| evaluate | | public Object evaluate(String arg)(Code) | | Call the argumentless method in the evaluatorClass and return the result of
it.
Parameters:
methodName - the name of the function to call the result of the function call |
| evaluatePath | | protected String evaluatePath(String path)(Code) | | Evaluate portions of the path within the evaluation tags '${}'. For example
'foo1/${foo2()}/foo3'. The foo2 function in the evaluator class will be
called in order to get the path information.
Parameters:
the - path being replaced the fixed path |
| export | | abstract public void export(String fileName)(Code) | | Retrieve a new TableBlock from this exporter
|
| getArrayArrayBlock | | abstract public ArrayArrayBlock getArrayArrayBlock()(Code) | | Retrieve a new ArrayArrayBlock from this exporter
a new ArrayArrayBlock Object |
| getBlock | | public Block getBlock(String className)(Code) | | Create and return a new Block Object from the class specified by the
fully qualified className parameter
Parameters:
className - the name of the Block class to create the created Block Object |
| getContentType | | abstract public String getContentType()(Code) | | Get the content type supported by this exporter
"HTML or XL or PDF depending on the instance" |
| getContents | | public String getContents()(Code) | | Retrieve the content of the export.
the content of the export |
| getCurrentProject | | public XProject getCurrentProject()(Code) | | Get the project that this exporter belongs to
the project |
| getExporter | | public static Exporter getExporter(XProject currentProject, Object instance, int type)(Code) | | Retrieve a new Exporter of type specified by the type argument. Supported
types are HTML_EXPORTER, PDF_EXPORTER and XL_EXPORTER.
Parameters:
instance - the current page or object that provides the methods or fields used in the evaluation
Parameters:
currentProject - the owner project
Parameters:
type - constant of either HTML_EXPORTER or XL_EXPORTER |
| getFileExtension | | abstract public String getFileExtension()(Code) | | Retrieve the file extension to be used for this export type.
a string containing the extension including the dot. |
| getFragmentBlock | | abstract public FragmentBlock getFragmentBlock()(Code) | | Retrieve a new FragmentBlock from this exporter
a new FragmentBlock Object |
| getFreeFormBlock | | abstract public Block getFreeFormBlock()(Code) | | Retrieve a new FreeFormBlock from this exporter
a new FreeFormBlock Object |
| getTableBlock | | abstract public TableBlock getTableBlock()(Code) | | Retrieve a new TableBlock from this exporter
a new TableBlock Object |
| getTableModelBlock | | abstract public TableModelBlock getTableModelBlock()(Code) | | Retrieve a new TableModelBlock from this exporter
a new TableModelBlock Object |
|
|
|