Package org.odftoolkit.odfdom.incubator.doc.number

Class OdfNumberTimeStyle

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.ElementImpl

org.apache.xerces.dom.ElementNSImpl

org.odftoolkit.odfdom.pkg.OdfElement

org.odftoolkit.odfdom.dom.element.number.DataStyleElement

org.odftoolkit.odfdom.dom.element.number.NumberDataStyleElementBase

org.odftoolkit.odfdom.dom.element.number.NumberTimeStyleElement

org.odftoolkit.odfdom.incubator.doc.number.OdfNumberTimeStyle

All Implemented Interfaces:

Serializable, Cloneable, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo

public class OdfNumberTimeStyle
extends NumberTimeStyleElement

Convenient functionalty for the parent ODF OpenDocument element

This class lets you create a date style from a format string. The format string is given in the same form as Java's SimpleDateFormat class.

The characters used are:

 a      Am/pm marker         PM
 H      Hour in day (0-23)   0
 k      Hour in day (1-24)   -- not in ODF
 K      Hour in am/pm (0-11) -- not in ODF
 h      Hour in am/pm (1-12) -- depends on AM/PM marker
 m      Minute in hour       30
 s      Second in minute     55
 S      Millisecond          -- not in ODF
 z      Time zone            -- not in ODF
 Z      Time zone RFC822     -- not in ODF
 

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.odftoolkit.odfdom.dom.element.number.DataStyleElement

DataStyleElement.NumberFormatType, DataStyleElement.StringToken, DataStyleElement.TokenType

Field Summary

Fields inherited from class org.odftoolkit.odfdom.dom.element.number.NumberTimeStyleElement

ELEMENT_NAME

Fields inherited from class org.apache.xerces.dom.ElementNSImpl

localName, namespaceURI

Fields inherited from class org.apache.xerces.dom.ElementImpl

attributes, name

Fields inherited from class org.apache.xerces.dom.ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class org.apache.xerces.dom.ChildNode

nextSibling, previousSibling

Fields inherited from class org.apache.xerces.dom.NodeImpl

DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Fields inherited from interface org.w3c.dom.TypeInfo

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Constructor Summary

Constructors

Constructor	Description
OdfNumberTimeStyle(OdfFileDom ownerDoc)
OdfNumberTimeStyle(OdfFileDom ownerDoc, String format, String styleName)	Creates a new instance of OdfTimeStyle.

Method Summary

Modifier and Type	Method	Description
String	getFormat(boolean capsDateFormat)	Get the format string that represents this style.
void	setFormat(String format)	Creates a <number:time-style> element based upon format.

Methods inherited from class org.odftoolkit.odfdom.dom.element.number.NumberTimeStyleElement

accept, getNumberFormatSourceAttribute, getNumberTruncateOnOverflowAttribute, getOdfName, newNumberAmPmElement, newNumberHoursElement, newNumberMinutesElement, newNumberSecondsElement, setNumberFormatSourceAttribute, setNumberTruncateOnOverflowAttribute

Methods inherited from class org.odftoolkit.odfdom.dom.element.number.NumberDataStyleElementBase

getNumberCountryAttribute, getNumberLanguageAttribute, getNumberRfcLanguageTagAttribute, getNumberScriptAttribute, getNumberTitleAttribute, getNumberTransliterationCountryAttribute, getNumberTransliterationFormatAttribute, getNumberTransliterationLanguageAttribute, getNumberTransliterationStyleAttribute, getStyleDisplayNameAttribute, getStyleNameAttribute, getStyleVolatileAttribute, newNumberTextElement, newStyleMapElement, newStyleTextPropertiesElement, setNumberCountryAttribute, setNumberLanguageAttribute, setNumberRfcLanguageTagAttribute, setNumberScriptAttribute, setNumberTitleAttribute, setNumberTransliterationCountryAttribute, setNumberTransliterationFormatAttribute, setNumberTransliterationLanguageAttribute, setNumberTransliterationStyleAttribute, setStyleDisplayNameAttribute, setStyleNameAttribute, setStyleVolatileAttribute

Methods inherited from class org.odftoolkit.odfdom.dom.element.number.DataStyleElement

emitColor, emitCurrency, emitNumber, emitText, emitTokens, getColorElement, getColorFromElement, getFormat, getMapping, getNumberFormat, tokenize

Methods inherited from class org.odftoolkit.odfdom.pkg.OdfElement

appendChild, appendUsingWhitespaceHandling, cloneElement, cloneNode, cloneNode, cloneNode, cloneOdfElement, componentSize, copyAttributes, countChildComponents, countDescendantComponents, countPrecedingSiblingElements, delete, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getChildElement, getChildElement, getComponent, getComponentRoot, getFirstChildElement, getLastChildElement, getNextSiblingElement, getOdfAttribute, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, getPreviousSiblingElement, getRepetition, getTextContent, hasAncestor, hasOdfAttribute, ignoredComponent, insert, insert, insertBefore, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, receiveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, selfAndDescendantTextIgnoredAsComponent, setComponent, setOdfAttribute, setOdfAttribute, setOdfAttributeValue, setRepetition, split, toString

Methods inherited from class org.apache.xerces.dom.ElementNSImpl

getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, getXMLBaseAttribute, isDerivedFrom, setPrefix, setType

Methods inherited from class org.apache.xerces.dom.ElementImpl

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getChildElementCount, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getLastElementChild, getNextElementSibling, getNodeName, getNodeType, getPreviousElementSibling, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttribute, hasAttributeNS, hasAttributes, isEqualNode, normalize, reconcileDefaultAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData

Methods inherited from class org.apache.xerces.dom.ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, hasChildNodes, item, setTextContent, synchronizeChildren

Methods inherited from class org.apache.xerces.dom.ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class org.apache.xerces.dom.NodeImpl

addEventListener, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setUserData, setUserData

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.w3c.dom.Node

compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getUserData, hasChildNodes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setTextContent, setUserData

Constructor Details

OdfNumberTimeStyle

public OdfNumberTimeStyle(OdfFileDom ownerDoc)

OdfNumberTimeStyle

public OdfNumberTimeStyle(OdfFileDom ownerDoc,
 String format,
 String styleName)

Creates a new instance of OdfTimeStyle.

Parameters:

ownerDoc - document that this format belongs to

format - format string for the date/time

styleName - name of this style

Method Details

getFormat

public String getFormat(boolean capsDateFormat)

Get the format string that represents this style.

Specified by:

getFormat in class DataStyleElement

Parameters:

capsDateFormat - use capitals

Returns:

the format string

setFormat

public void setFormat(String format)

Creates a <number:time-style> element based upon format.

Specified by:

setFormat in class DataStyleElement

Parameters:

format - the format for the time