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

This is a class to define a Name Definition structure. More...

Inheritance diagram for org.openoffice.xmerge.converter.xml.sxc.NameDefinition:
[legend]
Collaboration diagram for org.openoffice.xmerge.converter.xml.sxc.NameDefinition:
[legend]

Public Member Functions

 NameDefinition ()
 Default Constructor for a NameDefinition. More...
 
 NameDefinition (Node root)
 Constructor that takes a Node to build a NameDefinition. More...
 
 NameDefinition (String name, String definition, String baseCellAddress, boolean rangeType, boolean expressionType)
 Constructor for a NameDefinition. More...
 
void setDefinition (String newDefinition)
 Sets the definition. More...
 
void writeNode (org.w3c.dom.Document doc, Node root)
 Writes out a content.xml entry for this NameDefinition object. More...
 

Private Member Functions

String getName ()
 Returns Name of the definition. More...
 
String getDefinition ()
 Returns the definition itself. More...
 
String getBaseCellAddress ()
 Returns the base Cell address. More...
 
boolean isExpressionType ()
 Tests if definition is of type expression. More...
 
boolean isRangeType ()
 Tests if definition is of type range. More...
 
void readNode (Node root)
 Reads document settings from xml and inits Settings variables. More...
 

Private Attributes

String name
 
String definition
 
String baseCellAddress
 
boolean rangeType = false
 
boolean expressionType = false
 

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 to define a Name Definition structure.

This can then be used by plug-ins to write or read their own definition types.

Definition at line 35 of file NameDefinition.java.

Constructor & Destructor Documentation

◆ NameDefinition() [1/3]

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

Default Constructor for a NameDefinition.

Definition at line 46 of file NameDefinition.java.

◆ NameDefinition() [2/3]

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

Constructor that takes a Node to build a NameDefinition.

Parameters
rootXML Node to read from.

Definition at line 54 of file NameDefinition.java.

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

◆ NameDefinition() [3/3]

org.openoffice.xmerge.converter.xml.sxc.NameDefinition.NameDefinition ( String  name,
String  definition,
String  baseCellAddress,
boolean  rangeType,
boolean  expressionType 
)
inline

Constructor for a NameDefinition.

Parameters
nameName that identifies the definition.
definitionThe definition itself.
baseCellAddressThe base cell address.
rangeTypetrue if definition of range type.
expressionTypetrue if definition of expression type.

Definition at line 67 of file NameDefinition.java.

References org.openoffice.xmerge.converter.xml.sxc.NameDefinition.baseCellAddress, org.openoffice.xmerge.converter.xml.sxc.NameDefinition.definition, org.openoffice.xmerge.converter.xml.sxc.NameDefinition.expressionType, org.openoffice.xmerge.converter.xml.sxc.NameDefinition.name, and org.openoffice.xmerge.converter.xml.sxc.NameDefinition.rangeType.

Member Function Documentation

◆ getBaseCellAddress()

String org.openoffice.xmerge.converter.xml.sxc.NameDefinition.getBaseCellAddress ( )
inlineprivate

Returns the base Cell address.

Returns
the base cell address.

Definition at line 108 of file NameDefinition.java.

References org.openoffice.xmerge.converter.xml.sxc.NameDefinition.baseCellAddress, and String.

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

◆ getDefinition()

String org.openoffice.xmerge.converter.xml.sxc.NameDefinition.getDefinition ( )
inlineprivate

Returns the definition itself.

Returns
the definition.

Definition at line 99 of file NameDefinition.java.

References org.openoffice.xmerge.converter.xml.sxc.NameDefinition.definition, and String.

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

◆ getName()

String org.openoffice.xmerge.converter.xml.sxc.NameDefinition.getName ( )
inlineprivate

Returns Name of the definition.

Returns
the name which identifies the definition.

Definition at line 81 of file NameDefinition.java.

References org.openoffice.xmerge.converter.xml.sxc.NameDefinition.name, and String.

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

◆ isExpressionType()

boolean org.openoffice.xmerge.converter.xml.sxc.NameDefinition.isExpressionType ( )
inlineprivate

Tests if definition is of type expression.

Returns
whether or not this name definition is of type expression.

Definition at line 117 of file NameDefinition.java.

References org.openoffice.xmerge.converter.xml.sxc.NameDefinition.expressionType.

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

◆ isRangeType()

boolean org.openoffice.xmerge.converter.xml.sxc.NameDefinition.isRangeType ( )
inlineprivate

Tests if definition is of type range.

Returns
whether or not this name definition is of type range.

Definition at line 126 of file NameDefinition.java.

References org.openoffice.xmerge.converter.xml.sxc.NameDefinition.rangeType.

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

◆ readNode()

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

◆ setDefinition()

void org.openoffice.xmerge.converter.xml.sxc.NameDefinition.setDefinition ( String  newDefinition)
inline

Sets the definition.

Parameters
newDefinitionsets the definition.

Definition at line 90 of file NameDefinition.java.

References org.openoffice.xmerge.converter.xml.sxc.NameDefinition.definition.

◆ writeNode()

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

Member Data Documentation

◆ baseCellAddress

String org.openoffice.xmerge.converter.xml.sxc.NameDefinition.baseCellAddress
private

◆ definition

String org.openoffice.xmerge.converter.xml.sxc.NameDefinition.definition
private

◆ expressionType

boolean org.openoffice.xmerge.converter.xml.sxc.NameDefinition.expressionType = false
private

◆ name

String org.openoffice.xmerge.converter.xml.sxc.NameDefinition.name
private

◆ rangeType

boolean org.openoffice.xmerge.converter.xml.sxc.NameDefinition.rangeType = false
private

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