xelem.3.0

nl.fountain.xelem.excel.x
Class XPane

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

public class XPane
extends AbstractXLElement
implements Pane

An implementation of the XLElement Pane. Methods of this class are mainly used by WorksheetOptions-methods.

See Also:
WorksheetOptions.setActiveCell(int, int, int), WorksheetOptions.setActiveCell(int, int), WorksheetOptions.freezePanesAt(int, int), WorksheetOptions.splitHorizontal(int, int), WorksheetOptions.splitVertical(int, int), WorksheetOptions.setRangeSelection(int, String), WorksheetOptions.setRangeSelection(String)

Field Summary
 
Fields inherited from interface nl.fountain.xelem.excel.Pane
BOTTOM_LEFT, BOTTOM_RIGHT, TOP_LEFT, TOP_RIGHT
 
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
XPane(int paneNumber)
          Constructs a new XPane with the given pane number.
 
Method Summary
 Element assemble(Element parent, GIO gio)
          Assembles the state of this XLElement and all of it's children into an Element.
 int getActiveCol()
           
 int getActiveRow()
           
 String getNameSpace()
          Gets the namespace of this XLElement.
 int getNumber()
           
 String getPrefix()
          Gets the prefix of this XLElement.
 String getRangeSelection()
           
 String getTagName()
          Gets the tagname (localName) of this XLElement.
 void setActiveCell(int row, int col)
           
 void setActiveCol(int col)
           
 void setActiveRow(int row)
           
 void setRangeSelection(Area area)
           
 void setRangeSelection(String rc)
           
 
Methods inherited from class nl.fountain.xelem.excel.AbstractXLElement
addElementComment, assemble, createAttributeNS, createAttributeNS, createElementNS, createElementNS, createElementNS, createElementNS, getElementComments, setAttributes, setChildElement
 
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, setChildElement
 

Constructor Detail

XPane

public XPane(int paneNumber)
Constructs a new XPane with the given pane number.

Throws:
IllegalArgumentException - if paneNumber < 0 or paneNumber > 3.
Method Detail

getNumber

public int getNumber()
Specified by:
getNumber in interface Pane

setActiveCol

public void setActiveCol(int col)
Specified by:
setActiveCol in interface Pane

getActiveCol

public int getActiveCol()
Specified by:
getActiveCol in interface Pane

setActiveRow

public void setActiveRow(int row)
Specified by:
setActiveRow in interface Pane

getActiveRow

public int getActiveRow()
Specified by:
getActiveRow in interface Pane

setActiveCell

public void setActiveCell(int row,
                          int col)
Specified by:
setActiveCell in interface Pane

setRangeSelection

public void setRangeSelection(String rc)
Specified by:
setRangeSelection in interface Pane

setRangeSelection

public void setRangeSelection(Area area)
Specified by:
setRangeSelection in interface Pane

getRangeSelection

public String getRangeSelection()
Specified by:
getRangeSelection in interface Pane

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.

xelem.3.0