org.odftoolkit.odfdom.doc.number
Class OdfNumberDateStyle

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.OdfElement
                          org.odftoolkit.odfdom.dom.element.number.NumberDateStyleElement
                              org.odftoolkit.odfdom.doc.number.OdfNumberDateStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, org.w3c.dom.Element, org.w3c.dom.events.EventTarget, org.w3c.dom.Node, org.w3c.dom.NodeList, org.w3c.dom.TypeInfo

public class OdfNumberDateStyle
extends NumberDateStyleElement

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:

G       Era designator       AD
y       Year                 1996; 96
Q       Quarter in Year      2 -- not in Java; in ODF
M       Month in year        July; Jul; 07
w       Week in year         27
W       Week in month        -- not in ODF
D       Day in year          -- not in ODF
d       Day in month         10
F       Day of week in month -- not in ODF
E       Day in week          Tuesday; Tue
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
 

The G, E, and y specifiers are in long form if there are more then 3 in a row. The Q specifier is in long form if there are more than 2 in a row. The d, h, and m specifiers are in long form if there is more than one in a row.

See Also:

Serialized Form

Field Summary

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

ELEMENT_NAME

Fields inherited from class org.odftoolkit.odfdom.OdfElement

mOdfDocument

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

OdfNumberDateStyle(OdfFileDom ownerDoc)

OdfNumberDateStyle(OdfFileDom ownerDoc, java.lang.String format, java.lang.String styleName, java.lang.String calendarName)
Creates a new instance of DateStyleFromFormat.

Method Summary

void	buildFromFormat(java.lang.String format) Creates a <number:date-style> element based upon format.
java.lang.String	getFormat() Get the format string that represents this style.

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

getNumberAutomaticOrderAttribute, getNumberCountryAttribute, getNumberFormatSourceAttribute, getNumberLanguageAttribute, getNumberRfcLanguageTagAttribute, getNumberScriptAttribute, getNumberTitleAttribute, getNumberTransliterationCountryAttribute, getNumberTransliterationFormatAttribute, getNumberTransliterationLanguageAttribute, getNumberTransliterationStyleAttribute, getOdfName, getStyleNameAttribute, getStyleVolatileAttribute, init, newNumberAmPmElement, newNumberDayElement, newNumberDayOfWeekElement, newNumberEraElement, newNumberHoursElement, newNumberMinutesElement, newNumberMonthElement, newNumberQuarterElement, newNumberSecondsElement, newNumberTextElement, newNumberWeekOfYearElement, newNumberYearElement, newStyleMapElement, newStyleTextPropertiesElement, newStyleTextPropertiesElement, setNumberAutomaticOrderAttribute, setNumberCountryAttribute, setNumberFormatSourceAttribute, setNumberLanguageAttribute, setNumberRfcLanguageTagAttribute, setNumberScriptAttribute, setNumberTitleAttribute, setNumberTransliterationCountryAttribute, setNumberTransliterationFormatAttribute, setNumberTransliterationLanguageAttribute, setNumberTransliterationStyleAttribute, setStyleNameAttribute, setStyleVolatileAttribute

Methods inherited from class org.odftoolkit.odfdom.OdfElement

cloneNode, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, hasOdfAttribute, insertBefore, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, removeChild, replaceChild, setOdfAttribute, setOdfAttributeValue, toString

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

getBaseURI, getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setPrefix, setType, setValues

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

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, 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, getTextContent, 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, appendChild, 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

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

Constructor Detail

OdfNumberDateStyle

public OdfNumberDateStyle(OdfFileDom ownerDoc)

OdfNumberDateStyle

public OdfNumberDateStyle(OdfFileDom ownerDoc,
                          java.lang.String format,
                          java.lang.String styleName,
                          java.lang.String calendarName)

Creates a new instance of DateStyleFromFormat.

Parameters:

ownerDoc - document that this format belongs to

format - format string for the date/time

styleName - name of this style

calendarName - name of the calendar this date style belongs to

Method Detail

getFormat

public java.lang.String getFormat()

Get the format string that represents this style.

Returns:

the format string

buildFromFormat

public void buildFromFormat(java.lang.String format)

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

Parameters:

format - the format string