nl.fountain.xelem.excel.x
Class XWorksheetOptions

java.lang.Object
  nl.fountain.xelem.excel.AbstractXLElement
      nl.fountain.xelem.excel.x.XWorksheetOptions

All Implemented Interfaces:

WorksheetOptions, XLElement

public class XWorksheetOptions
extends AbstractXLElement
implements WorksheetOptions

An implementation of the XLElement WorksheetOptions.

Field Summary

Fields inherited from interface nl.fountain.xelem.excel.WorksheetOptions

SHEET_HIDDEN, SHEET_VERY_HIDDEN, SHEET_VISIBLE

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

XWorksheetOptions()
Constructs a new XWorksheetOptions.

Method Summary

Element	assemble(Element parent, GIO gio) Assembles the state of this XLElement and all of it's children into an Element.
boolean	displaysFormulas()
boolean	displaysNoGridlines()
boolean	displaysNoHeadings()
void	doDisplayFormulas(boolean f)
void	doNotDisplayGridlines(boolean b)
void	doNotDisplayHeadings(boolean b)
void	freezePanesAt(int row, int column)
String	getGridlineColor()
int	getLeftColumnVisible()
String	getNameSpace() Gets the namespace of this XLElement.
String	getPrefix() Gets the prefix of this XLElement.
int	getTabColorIndex()
String	getTagName() Gets the tagname (localName) of this XLElement.
int	getTopRowVisible()
String	getVisible()
int	getZoom()
boolean	hasFrozenPanes()
boolean	hasHorizontalSplit()
boolean	hasSplit()
boolean	hasVerticalSplit()
boolean	isSelected()
void	setActiveCell(int r, int c)
void	setActiveCell(int paneNumber, int r, int c)
void	setChildElement(String localName, String content) Does effectively nothing.
void	setGridlineColor(int r, int g, int b)
void	setLeftColumnVisible(int lc)
void	setRangeSelection(Area area)
void	setRangeSelection(int paneNumber, String rcRange)
void	setRangeSelection(String rcRange) Sets a range selection.
void	setSelected(boolean s)
void	setTabColorIndex(int ci)
void	setTopRowVisible(int tr)
void	setVisible(String wsoValue)
void	setZoom(int z)
void	splitHorizontal(int points, int topRow)
void	splitVertical(int points, int leftColumn)

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

XWorksheetOptions

public XWorksheetOptions()

Constructs a new XWorksheetOptions.

See Also:

Worksheet.getWorksheetOptions()

Method Detail

setTopRowVisible

public void setTopRowVisible(int tr)

Specified by:

setTopRowVisible in interface WorksheetOptions

getTopRowVisible

public int getTopRowVisible()

Specified by:

getTopRowVisible in interface WorksheetOptions

setLeftColumnVisible

public void setLeftColumnVisible(int lc)

Specified by:

setLeftColumnVisible in interface WorksheetOptions

getLeftColumnVisible

public int getLeftColumnVisible()

Specified by:

getLeftColumnVisible in interface WorksheetOptions

setZoom

public void setZoom(int z)

Specified by:

setZoom in interface WorksheetOptions

getZoom

public int getZoom()

Specified by:

getZoom in interface WorksheetOptions

setTabColorIndex

public void setTabColorIndex(int ci)

Specified by:

setTabColorIndex in interface WorksheetOptions

getTabColorIndex

public int getTabColorIndex()

Specified by:

getTabColorIndex in interface WorksheetOptions

setSelected

public void setSelected(boolean s)

Specified by:

setSelected in interface WorksheetOptions

isSelected

public boolean isSelected()

Specified by:

isSelected in interface WorksheetOptions

doNotDisplayHeadings

public void doNotDisplayHeadings(boolean b)

Specified by:

doNotDisplayHeadings in interface WorksheetOptions

displaysNoHeadings

public boolean displaysNoHeadings()

Specified by:

displaysNoHeadings in interface WorksheetOptions

doNotDisplayGridlines

public void doNotDisplayGridlines(boolean b)

Specified by:

doNotDisplayGridlines in interface WorksheetOptions

displaysNoGridlines

public boolean displaysNoGridlines()

Specified by:

displaysNoGridlines in interface WorksheetOptions

doDisplayFormulas

public void doDisplayFormulas(boolean f)

Specified by:

doDisplayFormulas in interface WorksheetOptions

displaysFormulas

public boolean displaysFormulas()

Specified by:

displaysFormulas in interface WorksheetOptions

setVisible

public void setVisible(String wsoValue)

Specified by:

setVisible in interface WorksheetOptions

getVisible

public String getVisible()

Specified by:

getVisible in interface WorksheetOptions

setActiveCell

public void setActiveCell(int r,
                          int c)

Specified by:

setActiveCell in interface WorksheetOptions

Throws:

IllegalArgumentException - if r < 1 or c < 1.

setActiveCell

public void setActiveCell(int paneNumber,
                          int r,
                          int c)

Specified by:

setActiveCell in interface WorksheetOptions

Throws:

IllegalArgumentException - if paneNumber < 0 or paneNumber > 3.

IllegalArgumentException - if r < 1 or c < 1.

setRangeSelection

public void setRangeSelection(String rcRange)

Description copied from interface: WorksheetOptions

Sets a range selection. The active cell must also be set within the range in order for this method to have effect.

Specified by:

setRangeSelection in interface WorksheetOptions

Parameters:

rcRange - A String in R1C1 reference style.

See Also:

WorksheetOptions.setActiveCell(int, int)

setRangeSelection

public void setRangeSelection(Area area)

Specified by:

setRangeSelection in interface WorksheetOptions

setRangeSelection

public void setRangeSelection(int paneNumber,
                              String rcRange)

Specified by:

setRangeSelection in interface WorksheetOptions

Throws:

IllegalArgumentException - if paneNumber < 0 or paneNumber > 3.

splitHorizontal

public void splitHorizontal(int points,
                            int topRow)

Specified by:

splitHorizontal in interface WorksheetOptions

Throws:

IllegalArgumentException - if topRow < 1.

hasHorizontalSplit

public boolean hasHorizontalSplit()

Specified by:

hasHorizontalSplit in interface WorksheetOptions

splitVertical

public void splitVertical(int points,
                          int leftColumn)

Specified by:

splitVertical in interface WorksheetOptions

Throws:

IllegalArgumentException - if leftColumn < 1.

hasVerticalSplit

public boolean hasVerticalSplit()

Specified by:

hasVerticalSplit in interface WorksheetOptions

hasSplit

public boolean hasSplit()

Specified by:

hasSplit in interface WorksheetOptions

freezePanesAt

public void freezePanesAt(int row,
                          int column)

Specified by:

freezePanesAt in interface WorksheetOptions

hasFrozenPanes

public boolean hasFrozenPanes()

Specified by:

hasFrozenPanes in interface WorksheetOptions

setGridlineColor

public void setGridlineColor(int r,
                             int g,
                             int b)

Specified by:

setGridlineColor in interface WorksheetOptions

getGridlineColor

public String getGridlineColor()

Specified by:

getGridlineColor in interface WorksheetOptions

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

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