xelem.3.0

nl.fountain.xelem.excel.x
Class XExcelWorkbook

java.lang.Object
  extended by nl.fountain.xelem.excel.AbstractXLElement
      extended by nl.fountain.xelem.excel.x.XExcelWorkbook
All Implemented Interfaces:
ExcelWorkbook, XLElement

public class XExcelWorkbook
extends AbstractXLElement
implements ExcelWorkbook

An implementation of the XLElement ExcelWorkbook.


Field Summary
 
Fields inherited from interface nl.fountain.xelem.excel.XLElement
PREFIX_HTML, PREFIX_O, PREFIX_SS, PREFIX_X, XMLNS, XMLNS_HTML, XMLNS_O, XMLNS_SS, XMLNS_X
 
Constructor Summary
XExcelWorkbook()
          Creates a new XExcelWorkbook.
 
Method Summary
 Element assemble(Element parent, GIO gio)
          Assembles the state of this XLElement and all of it's children into an Element.
 int getActiveSheet()
          Gets the active sheet. 0 based.
 String getNameSpace()
          Gets the namespace of this XLElement.
 String getPrefix()
          Gets the prefix of this XLElement.
 boolean getProtectStructure()
           
 boolean getProtectWindows()
           
 String getTagName()
          Gets the tagname (localName) of this XLElement.
 int getWindowHeight()
           
 int getWindowTopX()
           
 int getWindowTopY()
           
 int getWindowWidth()
           
 void setActiveSheet(int nr)
          Set the active sheet. 0-based.
 void setChildElement(String localName, String content)
          Does effectively nothing.
 void setProtectStructure(boolean protect)
           
 void setProtectWindows(boolean protect)
           
 void setWindowHeight(int height)
           
 void setWindowTopX(int x)
           
 void setWindowTopY(int y)
           
 void setWindowWidth(int width)
           
 
Methods inherited from class nl.fountain.xelem.excel.AbstractXLElement
addElementComment, assemble, createAttributeNS, createAttributeNS, createElementNS, createElementNS, createElementNS, createElementNS, getElementComments, setAttributes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface nl.fountain.xelem.excel.XLElement
addElementComment, getElementComments, setAttributes
 

Constructor Detail

XExcelWorkbook

public XExcelWorkbook()
Creates a new XExcelWorkbook.

See Also:
Workbook.getExcelWorkbook()
Method Detail

setWindowHeight

public void setWindowHeight(int height)
Specified by:
setWindowHeight in interface ExcelWorkbook

getWindowHeight

public int getWindowHeight()
Specified by:
getWindowHeight in interface ExcelWorkbook

setWindowWidth

public void setWindowWidth(int width)
Specified by:
setWindowWidth in interface ExcelWorkbook

getWindowWidth

public int getWindowWidth()
Specified by:
getWindowWidth in interface ExcelWorkbook

setWindowTopX

public void setWindowTopX(int x)
Specified by:
setWindowTopX in interface ExcelWorkbook

getWindowTopX

public int getWindowTopX()
Specified by:
getWindowTopX in interface ExcelWorkbook

setWindowTopY

public void setWindowTopY(int y)
Specified by:
setWindowTopY in interface ExcelWorkbook

getWindowTopY

public int getWindowTopY()
Specified by:
getWindowTopY in interface ExcelWorkbook

setActiveSheet

public void setActiveSheet(int nr)
Description copied from interface: ExcelWorkbook
Set the active sheet. 0-based.

Specified by:
setActiveSheet in interface ExcelWorkbook
Parameters:
nr - the index of the active sheet.

getActiveSheet

public int getActiveSheet()
Description copied from interface: ExcelWorkbook
Gets the active sheet. 0 based.

Specified by:
getActiveSheet in interface ExcelWorkbook
Returns:
an int >= 0

setProtectStructure

public void setProtectStructure(boolean protect)
Specified by:
setProtectStructure in interface ExcelWorkbook

getProtectStructure

public boolean getProtectStructure()
Specified by:
getProtectStructure in interface ExcelWorkbook

setProtectWindows

public void setProtectWindows(boolean protect)
Specified by:
setProtectWindows in interface ExcelWorkbook

getProtectWindows

public boolean getProtectWindows()
Specified by:
getProtectWindows in interface ExcelWorkbook

getTagName

public String getTagName()
Description copied from interface: XLElement
Gets the tagname (localName) of this XLElement.

Specified by:
getTagName in interface XLElement
Returns:
qualified name

getNameSpace

public String getNameSpace()
Description copied from interface: XLElement
Gets the namespace of this XLElement.

Specified by:
getNameSpace in interface XLElement
Returns:
namespace

getPrefix

public String getPrefix()
Description copied from interface: XLElement
Gets the prefix of this XLElement.

Specified by:
getPrefix in interface XLElement
Returns:
prefix

assemble

public Element assemble(Element parent,
                        GIO gio)
Description copied from interface: XLElement
Assembles the state of this XLElement and all of it's children into an Element. Attaches the new element to it's parent-element if needed.

Specified by:
assemble in interface XLElement
Parameters:
parent - the parent-element to which the new formed element will be appended
gio - a global information object
Returns:
the newly assembled element. may be null.

setChildElement

public void setChildElement(String localName,
                            String content)
Description copied from class: AbstractXLElement
Does effectively nothing.

Specified by:
setChildElement in interface XLElement
Overrides:
setChildElement in class AbstractXLElement
Parameters:
localName - the local name of the child
content - the content of the child

xelem.3.0