Google Git
Sign in
apache / incubator-odftoolkit-site / d22ef2d53769a0a209d42b84c8275ad1d8522260 / . / content / odftoolkit / mvn-site / 0.8-incubating / simple-odf / apidocs / org / odftoolkit / simple / form / DateField.html
blob: 9b12e220502de96bf786ddfb6206f17f15b17c07 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri Feb 22 10:35:19 CET 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>DateField (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)</title>
<meta name="date" content="2013-02-22">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DateField (Simple ODF API v0.8-incubating - http://incubator.apache.org/odftoolkit/)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DateField.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/form/CurrencyField.html" title="class in org.odftoolkit.simple.form"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/form/Field.html" title="class in org.odftoolkit.simple.form"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/form/DateField.html" target="_top">Frames</a></li>
<li><a href="DateField.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.odftoolkit.simple.form.FormControl">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.odftoolkit.simple.form</div>
<h2 title="Class DateField" class="title">Class DateField</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Component</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">org.odftoolkit.simple.form.FormControl</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/odftoolkit/simple/form/Field.html" title="class in org.odftoolkit.simple.form">org.odftoolkit.simple.form.Field</a></li>
<li>
<ul class="inheritance">
<li>org.odftoolkit.simple.form.DateField</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">DateField</span>
extends <a href="../../../../org/odftoolkit/simple/form/Field.html" title="class in org.odftoolkit.simple.form">Field</a></pre>
<div class="block">This class represents a date field of form.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.odftoolkit.simple.form.FormControl">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.odftoolkit.simple.form.<a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a></h3>
<code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#drawingShape">drawingShape</a>, <a href="../../../../org/odftoolkit/simple/form/FormControl.html#formElement">formElement</a>, <a href="../../../../org/odftoolkit/simple/form/FormControl.html#mElement">mElement</a>, <a href="../../../../org/odftoolkit/simple/form/FormControl.html#mFormProperties">mFormProperties</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/DateField.html#formatDate(java.lang.String, java.util.Locale)">formatDate</a></strong>(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;formatStr,
<a href="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</code>
<div class="block">Format the date value according to the appointed format and locale.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/DateField.html#getDateFormat()">getDateFormat</a></strong>()</code>
<div class="block">Get the format code which is used to format the display value</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/form/DateField.html" title="class in org.odftoolkit.simple.form">DateField</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/DateField.html#getInstanceOf(org.odftoolkit.odfdom.dom.element.form.FormFormattedTextElement)">getInstanceOf</a></strong>(org.odftoolkit.odfdom.dom.element.form.FormFormattedTextElement&nbsp;element)</code>
<div class="block">Get an instance of date field by an instance of FormFormattedTextElement,
while searching the document content to make a bind with the DrawControl
which already reference to this date field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/DateField.html#setDropDownVisible(boolean)">setDropDownVisible</a></strong>(boolean&nbsp;isVisible)</code>
<div class="block">Set the visibility of the drop-down button.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.form.Field">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.form.<a href="../../../../org/odftoolkit/simple/form/Field.html" title="class in org.odftoolkit.simple.form">Field</a></h3>
<code><a href="../../../../org/odftoolkit/simple/form/Field.html#getCurrentValue()">getCurrentValue</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#getFormatString(org.odftoolkit.odfdom.dom.attribute.office.OfficeValueTypeAttribute.Value)">getFormatString</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#getId()">getId</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#getName()">getName</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#getSimpleIterator(org.odftoolkit.simple.form.Form)">getSimpleIterator</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#getValue()">getValue</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#setControlImplementation(java.lang.String)">setControlImplementation</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#setCurrentValue(java.lang.String)">setCurrentValue</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#setFormatString(java.lang.String, org.odftoolkit.odfdom.dom.attribute.office.OfficeValueTypeAttribute.Value, java.util.Locale)">setFormatString</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#setId(java.lang.String)">setId</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#setName(java.lang.String)">setName</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#setSpinButonVisible(boolean)">setSpinButonVisible</a>, <a href="../../../../org/odftoolkit/simple/form/Field.html#setValue(java.lang.String)">setValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.form.FormControl">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.form.<a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a></h3>
<code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#getDrawControl()">getDrawControl</a>, <a href="../../../../org/odftoolkit/simple/form/FormControl.html#getOdfElement()">getOdfElement</a>, <a href="../../../../org/odftoolkit/simple/form/FormControl.html#getRectangle()">getRectangle</a>, <a href="../../../../org/odftoolkit/simple/form/FormControl.html#remove()">remove</a>, <a href="../../../../org/odftoolkit/simple/form/FormControl.html#setAnchorType(org.odftoolkit.simple.style.StyleTypeDefinitions.AnchorType)">setAnchorType</a>, <a href="../../../../org/odftoolkit/simple/form/FormControl.html#setFormProperty(java.lang.String, java.lang.String, java.lang.String, java.lang.Boolean, java.lang.String, java.lang.String, java.lang.Double, java.lang.String)">setFormProperty</a>, <a href="../../../../org/odftoolkit/simple/form/FormControl.html#setRectangle(org.odftoolkit.simple.draw.FrameRectangle)">setRectangle</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.Component">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.odftoolkit.simple.<a href="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</a></h3>
<code><a href="../../../../org/odftoolkit/simple/Component.html#getComponentByElement(org.odftoolkit.odfdom.pkg.OdfElement)">getComponentByElement</a>, <a href="../../../../org/odftoolkit/simple/Component.html#getOwnerDocument()">getOwnerDocument</a>, <a href="../../../../org/odftoolkit/simple/Component.html#registerComponent(org.odftoolkit.simple.Component, org.odftoolkit.odfdom.pkg.OdfElement)">registerComponent</a>, <a href="../../../../org/odftoolkit/simple/Component.html#unregisterComponent(org.odftoolkit.odfdom.pkg.OdfElement)">unregisterComponent</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstanceOf(org.odftoolkit.odfdom.dom.element.form.FormFormattedTextElement)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstanceOf</h4>
<pre>public static&nbsp;<a href="../../../../org/odftoolkit/simple/form/DateField.html" title="class in org.odftoolkit.simple.form">DateField</a>&nbsp;getInstanceOf(org.odftoolkit.odfdom.dom.element.form.FormFormattedTextElement&nbsp;element)</pre>
<div class="block">Get an instance of date field by an instance of FormFormattedTextElement,
while searching the document content to make a bind with the DrawControl
which already reference to this date field.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>element</code> - - an instance of FormFormattedTextElement</dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance of date field</dd></dl>
</li>
</ul>
<a name="setDropDownVisible(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDropDownVisible</h4>
<pre>public&nbsp;void&nbsp;setDropDownVisible(boolean&nbsp;isVisible)</pre>
<div class="block">Set the visibility of the drop-down button.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>isVisible</code> - - the visibility of drop-down button.</dd></dl>
</li>
</ul>
<a name="formatDate(java.lang.String, java.util.Locale)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>formatDate</h4>
<pre>public&nbsp;void&nbsp;formatDate(<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;formatStr,
<a href="http://download.oracle.com/javase/6/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a>&nbsp;locale)</pre>
<div class="block">Format the date value according to the appointed format and locale.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatStr</code> - - format code</dd><dd><code>locale</code> - - locale information</dd></dl>
</li>
</ul>
<a name="getDateFormat()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDateFormat</h4>
<pre>public&nbsp;<a href="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getDateFormat()</pre>
<div class="block">Get the format code which is used to format the display value</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the format code</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/DateField.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/odftoolkit/simple/form/CurrencyField.html" title="class in org.odftoolkit.simple.form"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/odftoolkit/simple/form/Field.html" title="class in org.odftoolkit.simple.form"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/odftoolkit/simple/form/DateField.html" target="_top">Frames</a></li>
<li><a href="DateField.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.odftoolkit.simple.form.FormControl">Field</a>&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>