This is a class representing the different attributes for a worksheet contained in settings.xml. More...

Inheritance diagram for org.openoffice.xmerge.converter.xml.sxc.BookSettings:

Collaboration diagram for org.openoffice.xmerge.converter.xml.sxc.BookSettings:

Public Member Functions
	BookSettings (Node root)
	Constructor for a `BookSettings`. More...

	BookSettings (ArrayList< SheetSettings > worksheetSettings)
	Constructor for a `BookSettings`. More...

void	setColumnRowHeaders (boolean hasColumnRowHeaders)
	Set the flag indicating whether we have row/column headers. More...

ArrayList< SheetSettings >	getSheetSettings ()
	Gets the `Vector` of `SheetSettings`. More...

String	getActiveSheet ()
	Gets the active sheet name. More...

void	setActiveSheet (String activeSheet)
	Sets the active sheet name. More...

void	writeNode (org.w3c.dom.Document settings, Node root)
	Writes out a settings.xml entry for this `BookSettings` object. More...

Private Member Functions
void	addConfigItem (Node root, String attribute, String type, String value)
	Adds an XML entry for a particular setting. More...

void	addAttribute (String name, String value)
	Sets a variable based on a `String` value read from XML. More...

void	readNode (Node root)
	Reads document settings from xml and inits `SheetSettings` variables. More...

Private Attributes
org.w3c.dom.Document	settings = null
	A w3c `Document`. More...

boolean	hasColumnRowHeaders = true

String	activeSheet = ""

ArrayList< SheetSettings >	worksheetSettings = new ArrayList<SheetSettings>()

Additional Inherited Members
Public Attributes inherited from org.openoffice.xmerge.converter.xml.OfficeConstants
String	TAG_OFFICE_DOCUMENT = "office:document"
	Element tag for office:document, this is the root tag. More...

String	TAG_OFFICE_DOCUMENT_CONTENT = "office:document-content"
	Element tag for office:document-content, this is the root tag in content.xml. More...

String	TAG_OFFICE_DOCUMENT_SETTINGS = "office:document-settings"
	Element tag for office:document-settings, this is the root tag in content.xml. More...

String	TAG_OFFICE_DOCUMENT_META = "office:document-meta"
	Element tag for office:document-meta, this is the root tag in content.xml. More...

String	TAG_OFFICE_DOCUMENT_STYLES = "office:document-styles"
	Element tag for office:document-styles, this is the root tag in styles.xml. More...

String	TAG_OFFICE_STYLES = "office:styles"
	Element tag for office:styles. More...

String	TAG_OFFICE_META = "office:meta"
	Element tag for office:meta. More...

String	TAG_OFFICE_AUTOMATIC_STYLES = "office:automatic-styles"
	Element tag for office:automatic-styles. More...

String	TAG_OFFICE_MASTER_STYLES = "office:master-styles"
	Element tag for office:master-styles. More...

String	TAG_OFFICE_BODY = "office:body"
	Element tag for office:body. More...

String	TAG_OFFICE_SETTINGS = "office:settings"
	Element tag for office:settings. More...

String	TAG_OFFICE_FONT_DECLS = "office:font-decls"
	Element tag for office:font-decls. More...

String	TAG_STYLE_FONT_DECL = "style:font-decl"
	Element tag for style:font-decl. More...

String	ATTRIBUTE_STYLE_NAME = "style:name"
	Attribute tag for style:name of element style:name. More...

String	ATTRIBUTE_STYLE_FONT_PITCH = "style:font-pitch"
	Attribute tag for style:font-pitch of element style:font-pitch. More...

String	ATTRIBUTE_FO_FONT_FAMILY = "fo:font-family"
	Attribute tag for fo:font-family of element fo:font-family. More...

String	ATTRIBUTE_FO_FONT_FAMILY_GENERIC = "fo:font-family-generic"
	Attribute tag for fo:font-family of element fo:font-family. More...

String	TAG_PARAGRAPH = "text:p"
	Element tag for text:p. More...

String	TAG_HEADING = "text:h"
	Element tag for text:h. More...

String	TAG_SPACE = "text:s"
	Element tag for text:s. More...

String	TAG_TAB_STOP = "text:tab-stop"
	Element tag for text:tab-stop. More...

String	TAG_LINE_BREAK = "text:line-break"
	Element tag for text:line-break. More...

String	TAG_SPAN = "text:span"
	Element tag for text:span. More...

String	TAG_HYPERLINK = "text:a"
	Element tag for text:a. More...

String	TAG_UNORDERED_LIST = "text:unordered-list"
	Element tag for text:unordered-list. More...

String	TAG_ORDERED_LIST = "text:ordered-list"
	Element tag for text:ordered-list. More...

String	TAG_LIST_HEADER = "text:list-header"
	Element tag for text:list-header. More...

String	TAG_LIST_ITEM = "text:list-item"
	Element tag for text:list-item. More...

String	ATTRIBUTE_SPACE_COUNT = "text:c"
	Attribute tag for text:c of element text:s. More...

String	TAG_TABLE = "table:table"
	Element tag for table:table. More...

String	TAG_NAMED_EXPRESSIONS = "table:named-expressions"
	Element tag for table:named-expression. More...

String	TAG_TABLE_NAMED_RANGE = "table:named-range"
	Element tag for table:named-range. More...

String	TAG_TABLE_NAMED_EXPRESSION = "table:named-expression"
	Element tag for table:named-expression. More...

String	ATTRIBUTE_TABLE_NAME = "table:name"
	Attribute tag for table:name of element table:table. More...

String	ATTRIBUTE_TABLE_EXPRESSION = "table:expression"
	Attribute tag for table:expression of element table:named-range. More...

String	ATTRIBUTE_TABLE_BASE_CELL_ADDRESS = "table:base-cell-address"
	Attribute tag for table:base-cell-address of element table:named-range. More...

String	ATTRIBUTE_TABLE_CELL_RANGE_ADDRESS = "table:cell-range-address"
	Attribute tag for table:cell-range-address of element table:named-range. More...

String	TAG_TABLE_ROW = "table:table-row"
	Element tag for table:table-row. More...

String	TAG_TABLE_COLUMN = "table:table-column"
	Element tag for table:table-column. More...

String	ATTRIBUTE_DEFAULT_CELL_STYLE = "table:default-cell-style-name"
	Attribute tag for table:default-cell-style-name of element table:table-column. More...

String	TAG_TABLE_SCENARIO = "table:scenario"
	Element tag for table:scenario. More...

String	TAG_TABLE_CELL = "table:table-cell"
	Element tag for table:table-cell. More...

String	ATTRIBUTE_TABLE_VALUE_TYPE = "table:value-type"
	Attribute tag for table:value-type of element table:table-cell. More...

String	ATTRIBUTE_TABLE_NUM_COLUMNS_REPEATED
	Attribute tag for table:number-columns-repeated of element table:table-cell. More...

String	ATTRIBUTE_TABLE_NUM_ROWS_REPEATED = "table:number-rows-repeated"
	Attribute tag for table:number-rows-repeated of element table:table-row. More...

String	ATTRIBUTE_TABLE_FORMULA = "table:formula"
	Attribute tag for table:formula of element table:table-cell. More...

String	ATTRIBUTE_TABLE_VALUE = "table:value"
	Attribute tag for table:value of element table:table-cell. More...

String	ATTRIBUTE_TABLE_DATE_VALUE = "table:date-value"
	Attribute tag for table:date-value of element table:table-cell. More...

String	ATTRIBUTE_TABLE_TIME_VALUE = "table:time-value"
	Attribute tag for table:time-value of element table:table-cell. More...

String	ATTRIBUTE_TABLE_STRING_VALUE = "table:string-value"
	Attribute tag for table:string-value of element table:table-cell. More...

String	ATTRIBUTE_TABLE_BOOLEAN_VALUE = "table:boolean-value"
	Attribute tag for table:time-boolean-value of element table:table-cell. More...

String	ATTRIBUTE_TABLE_STYLE_NAME = "table:style-name"
	Attribute tag for table:style-name of table elements. More...

String	ATTRIBUTE_TABLE_CURRENCY = "table:currency"
	Attribute tag for table:currency of element table:table-cell. More...

String	CELLTYPE_STRING = "string"
	The cell contains data of type string. More...

String	CELLTYPE_FLOAT = "float"
	The cell contains data of type float. More...

String	CELLTYPE_TIME = "time"
	The cell contains data of type time. More...

String	CELLTYPE_DATE = "date"
	The cell contains data of type date. More...

String	CELLTYPE_CURRENCY = "currency"
	The cell contains data of type currency. More...

String	CELLTYPE_BOOLEAN = "boolean"
	The cell contains data of type boolean. More...

String	CELLTYPE_PERCENT = "percentage"
	The cell contains data of type percent. More...

String	SXW_FILE_EXTENSION = ".sxw"
	StarWriter XML file extension. More...

String	SXW_TYPE = "text"
	StarWriter XML office:class value. More...

String	SXC_FILE_EXTENSION = ".sxc"
	StarCalc XML file extension. More...

String	SXC_TYPE = "spreadsheet"
	StarCalc XML office:class value. More...

String	TAG_MANIFEST_ROOT = "manifest:manifest"
	Element tag for manifest:manifestentry in Manifest XML. More...

String	TAG_MANIFEST_FILE = "manifest:file-entry"
	Element tag for manifest:file-entry entry in Manifest XML. More...

String	ATTRIBUTE_MANIFEST_FILE_TYPE = "manifest:media-type"
	Attribute tag for manifest:media-type of element manifest:file-entry. More...

String	ATTRIBUTE_MANIFEST_FILE_PATH = "manifest:full-path"
	Attribute tag for manifest:full-path of element manifest:file-entry. More...

String	TAG_CONFIG_ITEM = "config:config-item"
	Element tag for config:config-item. More...

String	TAG_CONFIG_ITEM_SET = "config:config-item-set"
	Element tag for config:config-item-set. More...

String	TAG_CONFIG_ITEM_MAP_INDEXED = "config:config-item-map-indexed"
	Element tag for config:config-item-map-indexed. More...

String	TAG_CONFIG_ITEM_MAP_NAMED = "config:config-item-map-named"
	Element tag for config:config-item-map-named. More...

String	TAG_CONFIG_ITEM_MAP_ENTRY = "config:config-item-map-entry"
	Element tag for config:config-item-map-entry. More...

String	ATTRIBUTE_CONFIG_NAME = "config:name"
	Attribute tag for config:name of element config:config-item. More...

String	ATTRIBUTE_CONFIG_TYPE = "config:type"
	Attribute tag for config:type of element config:config-item. More...

String	SXW_MIME_TYPE = "application/vnd.sun.xml.writer"
	StarWriter XML MIME type. More...

String	SXC_MIME_TYPE = "application/vnd.sun.xml.calc"
	StarCalc XML MIME type. More...

Detailed Description

This is a class representing the different attributes for a worksheet contained in settings.xml.

Definition at line 35 of file BookSettings.java.

Constructor & Destructor Documentation

◆ BookSettings() [1/2]

org.openoffice.xmerge.converter.xml.sxc.BookSettings.BookSettings ( Node root )

inline

Constructor for a BookSettings.

Reads document settings from xml and inits SheetSettings variables.

Parameters

root	The root XML node to read from.

Definition at line 52 of file BookSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.BookSettings.readNode().

◆ BookSettings() [2/2]

org.openoffice.xmerge.converter.xml.sxc.BookSettings.BookSettings ( ArrayList< SheetSettings > worksheetSettings )

inline

Constructor for a BookSettings.

Parameters

worksheetSettings If it's a row the height, a column the width

Definition at line 61 of file BookSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.BookSettings.worksheetSettings.

Member Function Documentation

◆ addAttribute()

void org.openoffice.xmerge.converter.xml.sxc.BookSettings.addAttribute	(	String	name,
		String	value
	)

inlineprivate

Sets a variable based on a String value read from XML.

Parameters

name	xml name of the attribute to set.
value	`String` value for the attribute.

Definition at line 147 of file BookSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.BookSettings.activeSheet, Boolean, org.openoffice.xmerge.converter.xml.sxc.BookSettings.hasColumnRowHeaders, name, and value.

Referenced by org.openoffice.xmerge.converter.xml.sxc.BookSettings.readNode().

◆ addConfigItem()

void org.openoffice.xmerge.converter.xml.sxc.BookSettings.addConfigItem	(	Node	root,
		String	attribute,
		String	type,
		String	value
	)

inlineprivate

Adds an XML entry for a particular setting.

Parameters

root	the root node at which to add the xml entry.
attribute	the name of the attribute to add.
type	the attribute type (`int`, `short` etc).
value	the value of the attribute.

Definition at line 109 of file BookSettings.java.

References attribute, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_CONFIG_NAME, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_CONFIG_TYPE, org.openoffice.xmerge.converter.xml.sxc.BookSettings.settings, org.openoffice.xmerge.converter.xml.OfficeConstants.TAG_CONFIG_ITEM, type, and value.

Referenced by org.openoffice.xmerge.converter.xml.sxc.BookSettings.writeNode().

◆ getActiveSheet()

String org.openoffice.xmerge.converter.xml.sxc.BookSettings.getActiveSheet ( )

inline

Gets the active sheet name.

Returns: the active sheet name

Definition at line 88 of file BookSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.BookSettings.activeSheet, and String.

◆ getSheetSettings()

ArrayList< SheetSettings > org.openoffice.xmerge.converter.xml.sxc.BookSettings.getSheetSettings ( )

inline

Gets the Vector of SheetSettings.

Returns: Vector of SheetSettings

Definition at line 79 of file BookSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.BookSettings.worksheetSettings.

◆ readNode()

void org.openoffice.xmerge.converter.xml.sxc.BookSettings.readNode ( Node root )

inlineprivate

Reads document settings from xml and inits SheetSettings variables.

Parameters

root	XML `Node` to read from.

Definition at line 160 of file BookSettings.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.BookSettings.BookSettings(), and org.openoffice.xmerge.converter.xml.sxc.BookSettings.readNode().

◆ setActiveSheet()

void org.openoffice.xmerge.converter.xml.sxc.BookSettings.setActiveSheet ( String activeSheet )

inline

Sets the active sheet name.

Parameters

activeSheet the active sheet name.

Definition at line 97 of file BookSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.BookSettings.activeSheet.

◆ setColumnRowHeaders()

void org.openoffice.xmerge.converter.xml.sxc.BookSettings.setColumnRowHeaders ( boolean hasColumnRowHeaders )

inline

Set the flag indicating whether we have row/column headers.

Parameters

hasColumnRowHeaders Flag to enable or disable headers.

Definition at line 70 of file BookSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.BookSettings.hasColumnRowHeaders.

◆ writeNode()

void org.openoffice.xmerge.converter.xml.sxc.BookSettings.writeNode	(	org.w3c.dom.Document	settings,
		Node	root
	)

inline

Writes out a settings.xml entry for this BookSettings object.

Parameters

settings	a `Document` object representing the settings.xml
root	the root xml node to add to.

Definition at line 127 of file BookSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.BookSettings.activeSheet, org.openoffice.xmerge.converter.xml.sxc.BookSettings.addConfigItem(), org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_CONFIG_NAME, Boolean, org.openoffice.xmerge.converter.xml.sxc.BookSettings.hasColumnRowHeaders, org.openoffice.xmerge.converter.xml.sxc.BookSettings.settings, String, org.openoffice.xmerge.converter.xml.OfficeConstants.TAG_CONFIG_ITEM_MAP_NAMED, and org.openoffice.xmerge.converter.xml.sxc.BookSettings.worksheetSettings.

Referenced by org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializer.processSettings().

Member Data Documentation

◆ activeSheet

String org.openoffice.xmerge.converter.xml.sxc.BookSettings.activeSheet = ""

private

Definition at line 41 of file BookSettings.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.BookSettings.addAttribute(), org.openoffice.xmerge.converter.xml.sxc.BookSettings.getActiveSheet(), org.openoffice.xmerge.converter.xml.sxc.BookSettings.setActiveSheet(), and org.openoffice.xmerge.converter.xml.sxc.BookSettings.writeNode().

◆ hasColumnRowHeaders

boolean org.openoffice.xmerge.converter.xml.sxc.BookSettings.hasColumnRowHeaders = true

private

Definition at line 40 of file BookSettings.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.BookSettings.addAttribute(), org.openoffice.xmerge.converter.xml.sxc.BookSettings.setColumnRowHeaders(), and org.openoffice.xmerge.converter.xml.sxc.BookSettings.writeNode().

◆ settings

org.w3c.dom.Document org.openoffice.xmerge.converter.xml.sxc.BookSettings.settings = null

private

A w3c Document.

Definition at line 38 of file BookSettings.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.BookSettings.addConfigItem(), and org.openoffice.xmerge.converter.xml.sxc.BookSettings.writeNode().

◆ worksheetSettings

ArrayList<SheetSettings> org.openoffice.xmerge.converter.xml.sxc.BookSettings.worksheetSettings = new ArrayList<SheetSettings>()

private

Definition at line 42 of file BookSettings.java.

Referenced by org.openoffice.xmerge.converter.xml.sxc.BookSettings.BookSettings(), org.openoffice.xmerge.converter.xml.sxc.BookSettings.getSheetSettings(), org.openoffice.xmerge.converter.xml.sxc.BookSettings.readNode(), and org.openoffice.xmerge.converter.xml.sxc.BookSettings.writeNode().

The documentation for this class was generated from the following file:

BookSettings.java

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BookSettings() [1/2]

◆ BookSettings() [2/2]

Member Function Documentation

◆ addAttribute()

◆ addConfigItem()

◆ getActiveSheet()

◆ getSheetSettings()

◆ readNode()

◆ setActiveSheet()

◆ setColumnRowHeaders()

◆ writeNode()

Member Data Documentation

◆ activeSheet

◆ hasColumnRowHeaders

◆ settings

◆ worksheetSettings