LibreOffice Module xmerge (master)  1
Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
org.openoffice.xmerge.converter.xml.sxc.SheetSettings Class Reference

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.SheetSettings:
[legend]
Collaboration diagram for org.openoffice.xmerge.converter.xml.sxc.SheetSettings:
[legend]

Public Member Functions

 SheetSettings ()
 Default Constructor for a. More...
 
 SheetSettings (Node root)
 Constructor that takes a. More...
 
 SheetSettings (String name)
 Constructor for a. More...
 
void setCursor (Point activeCell)
 Sets the position of the active cell. More...
 
Point getCursor ()
 Gets the position of the active cell. More...
 
void setFreeze (Point splitPoint)
 Sets the position of the freeze. More...
 
void setSplit (Point splitPoint)
 Sets the position of the split. More...
 
Point getSplit ()
 Gets the position of the split. More...
 
Point getSplitType ()
 Gets the type of the split. More...
 
int getLeft ()
 Gets the leftmost column visible in the right pane. More...
 
int getTop ()
 Gets the top row visible in the lower pane. More...
 
int getPaneNumber ()
 Gets the active Panel. More...
 
void setSheetName (String sheetName)
 Sets the. More...
 
void setPaneNumber (int paneNumber)
 Sets the active pane number. More...
 
void writeNode (org.w3c.dom.Document settings, Node root)
 Writes out a settings.xml entry for this. More...
 

Private Member Functions

String getSheetName ()
 Gets the name of the worksheet these. More...
 
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. More...
 
void readNode (Node root)
 Reads document settings from xml and inits. More...
 

Private Attributes

org.w3c.dom.Document settings = null
 A w3c. More...
 
String sheetName
 
int cursorX = 0
 
int cursorY = 0
 
int splitTypeX
 
int splitTypeY
 
int splitPointX = 0
 
int splitPointY = 0
 
int posLeft = 0
 
int posTop = 0
 
int paneNumber = 2
 

Static Private Attributes

final static int SPLIT = 0x01
 
final static int FREEZE = 0x02
 

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 33 of file SheetSettings.java.

Constructor & Destructor Documentation

org.openoffice.xmerge.converter.xml.sxc.SheetSettings.SheetSettings ( )
inline

Default Constructor for a.

.

Definition at line 55 of file SheetSettings.java.

org.openoffice.xmerge.converter.xml.sxc.SheetSettings.SheetSettings ( Node  root)
inline

Constructor that takes a.

to build a

.

Parameters
rootXML to read from.

Definition at line 63 of file SheetSettings.java.

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

org.openoffice.xmerge.converter.xml.sxc.SheetSettings.SheetSettings ( String  name)
inline

Constructor for a.

.

Parameters
nameThe name for the new sheet.

Definition at line 72 of file SheetSettings.java.

Member Function Documentation

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

Sets a variable based on a.

value read from XML.

Parameters
namexml name of the attribute to set.
value

Definition at line 274 of file SheetSettings.java.

References Integer.

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

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

Adds an XML entry for a particular setting.

Parameters
rootthe root at which to add the xml entry.
attributethe name of the attribute to add.
typethe attribute type (
int
,
short
etc).
valuethe value of the attribute.

Definition at line 220 of file SheetSettings.java.

References org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_CONFIG_NAME, org.openoffice.xmerge.converter.xml.OfficeConstants.ATTRIBUTE_CONFIG_TYPE, org.openoffice.xmerge.converter.xml.sxc.SheetSettings.settings, and org.openoffice.xmerge.converter.xml.OfficeConstants.TAG_CONFIG_ITEM.

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

Point org.openoffice.xmerge.converter.xml.sxc.SheetSettings.getCursor ( )
inline

Gets the position of the active cell.

Returns
The position as a .

Definition at line 91 of file SheetSettings.java.

References Point.

int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.getLeft ( )
inline

Gets the leftmost column visible in the right pane.

Returns
the 0-based index to the column.

Definition at line 145 of file SheetSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.SheetSettings.posLeft.

int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.getPaneNumber ( )
inline

Gets the active Panel.

ValueMeaning
0Bottom Right
1Top Right
2Bottom Left
3Top Left
Returns
int
representing the active panel.

Definition at line 172 of file SheetSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.SheetSettings.paneNumber.

String org.openoffice.xmerge.converter.xml.sxc.SheetSettings.getSheetName ( )
inlineprivate

Gets the name of the worksheet these.

apply to.

Returns
the name of the worksheet.

Definition at line 208 of file SheetSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.SheetSettings.sheetName, and String.

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

Point org.openoffice.xmerge.converter.xml.sxc.SheetSettings.getSplit ( )
inline

Gets the position of the split.

Returns
The position as a where the split occurs.

Definition at line 125 of file SheetSettings.java.

References Point.

Point org.openoffice.xmerge.converter.xml.sxc.SheetSettings.getSplitType ( )
inline

Gets the type of the split.

Returns
The split type as a .

Definition at line 135 of file SheetSettings.java.

References Point.

int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.getTop ( )
inline

Gets the top row visible in the lower pane.

Returns
The top row visible in the lower pane.

Definition at line 154 of file SheetSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.SheetSettings.posTop.

void org.openoffice.xmerge.converter.xml.sxc.SheetSettings.readNode ( Node  root)
inlineprivate
void org.openoffice.xmerge.converter.xml.sxc.SheetSettings.setCursor ( Point  activeCell)
inline

Sets the position of the active cell.

Parameters
activeCellthe current cursor position.

Definition at line 81 of file SheetSettings.java.

void org.openoffice.xmerge.converter.xml.sxc.SheetSettings.setFreeze ( Point  splitPoint)
inline

Sets the position of the freeze.

Parameters
splitPointthe point at where the split occurs.

Definition at line 100 of file SheetSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.SheetSettings.FREEZE.

void org.openoffice.xmerge.converter.xml.sxc.SheetSettings.setPaneNumber ( int  paneNumber)
inline

Sets the active pane number.

ValueMeaning
0Bottom Right
1Top Right
2Bottom Left
3Top Left
Parameters
paneNumberthe pane number.

Definition at line 199 of file SheetSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.SheetSettings.paneNumber.

void org.openoffice.xmerge.converter.xml.sxc.SheetSettings.setSheetName ( String  sheetName)
inline

Sets the.

this settings object applies to.

Parameters
sheetNamethe name of the worksheet.

Definition at line 181 of file SheetSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.SheetSettings.sheetName.

void org.openoffice.xmerge.converter.xml.sxc.SheetSettings.setSplit ( Point  splitPoint)
inline

Sets the position of the split.

Parameters
splitPointthe point at where the split occurs.

Definition at line 112 of file SheetSettings.java.

References org.openoffice.xmerge.converter.xml.sxc.SheetSettings.SPLIT.

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

Member Data Documentation

int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.cursorX = 0
private

Definition at line 39 of file SheetSettings.java.

int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.cursorY = 0
private

Definition at line 40 of file SheetSettings.java.

final static int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.FREEZE = 0x02
staticprivate
int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.paneNumber = 2
private
int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.posLeft = 0
private
int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.posTop = 0
private
org.w3c.dom.Document org.openoffice.xmerge.converter.xml.sxc.SheetSettings.settings = null
private
String org.openoffice.xmerge.converter.xml.sxc.SheetSettings.sheetName
private
final static int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.SPLIT = 0x01
staticprivate
int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.splitPointX = 0
private

Definition at line 43 of file SheetSettings.java.

int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.splitPointY = 0
private

Definition at line 44 of file SheetSettings.java.

int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.splitTypeX
private

Definition at line 41 of file SheetSettings.java.

int org.openoffice.xmerge.converter.xml.sxc.SheetSettings.splitTypeY
private

Definition at line 42 of file SheetSettings.java.


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