| <!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>Field (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="Field (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/Field.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/DateField.html" title="class in org.odftoolkit.simple.form"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface 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/Field.html" target="_top">Frames</a></li> |
| <li><a href="Field.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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields_inherited_from_class_org.odftoolkit.simple.form.FormControl">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 Field" class="title">Class Field</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>org.odftoolkit.simple.form.Field</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../org/odftoolkit/simple/form/CurrencyField.html" title="class in org.odftoolkit.simple.form">CurrencyField</a>, <a href="../../../../org/odftoolkit/simple/form/DateField.html" title="class in org.odftoolkit.simple.form">DateField</a>, <a href="../../../../org/odftoolkit/simple/form/NumericField.html" title="class in org.odftoolkit.simple.form">NumericField</a>, <a href="../../../../org/odftoolkit/simple/form/PatternField.html" title="class in org.odftoolkit.simple.form">PatternField</a>, <a href="../../../../org/odftoolkit/simple/form/TimeField.html" title="class in org.odftoolkit.simple.form">TimeField</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">Field</span> |
| extends <a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a></pre> |
| <div class="block">This class represents the form control of Field, provides methods to get/set |
| the form properties and the style formatting of this control.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>0.8</dd></dl> |
| </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 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"> </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><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/Field.html#getCurrentValue()">getCurrentValue</a></strong>()</code> |
| <div class="block">Get the current value of this control</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/Field.html#getFormatString(org.odftoolkit.odfdom.dom.attribute.office.OfficeValueTypeAttribute.Value)">getFormatString</a></strong>(org.odftoolkit.odfdom.dom.attribute.office.OfficeValueTypeAttribute.Value typeValue)</code> |
| <div class="block">Get the format string of the field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/Field.html#getId()">getId</a></strong>()</code> |
| <div class="block">Get the control id.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../org/odftoolkit/simple/form/Field.html" title="class in org.odftoolkit.simple.form">Field</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/Field.html#getInstanceOf(org.odftoolkit.odfdom.dom.element.form.FormFormattedTextElement)">getInstanceOf</a></strong>(org.odftoolkit.odfdom.dom.element.form.FormFormattedTextElement element)</code> |
| <div class="block">Get an instance of field by an instance of FormFormattedTextElement, |
| while searching the document content to make a bind with the DrawControl |
| which already reference to this field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/Field.html#getName()">getName</a></strong>()</code> |
| <div class="block">Get the control name.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static <a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a>></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/Field.html#getSimpleIterator(org.odftoolkit.simple.form.Form)">getSimpleIterator</a></strong>(<a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a> container)</code> |
| <div class="block">Get a simple iterator for Field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <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/Field.html#getValue()">getValue</a></strong>()</code> |
| <div class="block">Get the default value of this control</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/Field.html#setControlImplementation(java.lang.String)">setControlImplementation</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> controlImpl)</code> |
| <div class="block">Set the implementation of this control.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/Field.html#setCurrentValue(java.lang.String)">setCurrentValue</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> value)</code> |
| <div class="block">Set the current value of this control, it override the default value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected void</code></td> |
| <td class="colLast"><code><strong><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></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> formatStr, |
| org.odftoolkit.odfdom.dom.attribute.office.OfficeValueTypeAttribute.Value type, |
| <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> locale)</code> |
| <div class="block">Set the format string of the field.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/Field.html#setId(java.lang.String)">setId</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> id)</code> |
| <div class="block">Set the control id.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/Field.html#setName(java.lang.String)">setName</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> name)</code> |
| <div class="block">Set the control name.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/Field.html#setSpinButonVisible(boolean)">setSpinButonVisible</a></strong>(boolean isVisible)</code> |
| <div class="block">Set the visibility of the spin button</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/odftoolkit/simple/form/Field.html#setValue(java.lang.String)">setValue</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> value)</code> |
| <div class="block">Set the default value of this control, it will be override by current |
| value.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.odftoolkit.simple.form.FormControl"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class 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 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 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 <a href="../../../../org/odftoolkit/simple/form/Field.html" title="class in org.odftoolkit.simple.form">Field</a> getInstanceOf(org.odftoolkit.odfdom.dom.element.form.FormFormattedTextElement element)</pre> |
| <div class="block">Get an instance of field by an instance of FormFormattedTextElement, |
| while searching the document content to make a bind with the DrawControl |
| which already reference to this 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 field</dd></dl> |
| </li> |
| </ul> |
| <a name="getId()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getId</h4> |
| <pre>public <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> getId()</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#getId()">FormControl</a></code></strong></div> |
| <div class="block">Get the control id.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#getId()">getId</a></code> in class <code><a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the control id.</dd></dl> |
| </li> |
| </ul> |
| <a name="setControlImplementation(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setControlImplementation</h4> |
| <pre>public void setControlImplementation(<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> controlImpl)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#setControlImplementation(java.lang.String)">FormControl</a></code></strong></div> |
| <div class="block">Set the implementation of this control.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#setControlImplementation(java.lang.String)">setControlImplementation</a></code> in class <code><a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>controlImpl</code> - - the implementation description of this control</dd></dl> |
| </li> |
| </ul> |
| <a name="setId(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setId</h4> |
| <pre>public void setId(<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> id)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#setId(java.lang.String)">FormControl</a></code></strong></div> |
| <div class="block">Set the control id.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#setId(java.lang.String)">setId</a></code> in class <code><a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>id</code> - -the control id.</dd></dl> |
| </li> |
| </ul> |
| <a name="getName()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public <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> getName()</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#getName()">FormControl</a></code></strong></div> |
| <div class="block">Get the control name.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#getName()">getName</a></code> in class <code><a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the control name.</dd></dl> |
| </li> |
| </ul> |
| <a name="setName(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>public void setName(<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> name)</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#setName(java.lang.String)">FormControl</a></code></strong></div> |
| <div class="block">Set the control name.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/odftoolkit/simple/form/FormControl.html#setName(java.lang.String)">setName</a></code> in class <code><a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a></code></dd> |
| <dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - - the control name.</dd></dl> |
| </li> |
| </ul> |
| <a name="setValue(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setValue</h4> |
| <pre>public void setValue(<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> value)</pre> |
| <div class="block">Set the default value of this control, it will be override by current |
| value.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - - default value</dd></dl> |
| </li> |
| </ul> |
| <a name="getValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValue</h4> |
| <pre>public <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> getValue()</pre> |
| <div class="block">Get the default value of this control</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>default value</dd></dl> |
| </li> |
| </ul> |
| <a name="setCurrentValue(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCurrentValue</h4> |
| <pre>public void setCurrentValue(<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> value)</pre> |
| <div class="block">Set the current value of this control, it override the default value.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>currentValue</code> - - current value</dd></dl> |
| </li> |
| </ul> |
| <a name="getCurrentValue()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCurrentValue</h4> |
| <pre>public <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> getCurrentValue()</pre> |
| <div class="block">Get the current value of this control</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>current value</dd></dl> |
| </li> |
| </ul> |
| <a name="setSpinButonVisible(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSpinButonVisible</h4> |
| <pre>public void setSpinButonVisible(boolean isVisible)</pre> |
| <div class="block">Set the visibility of the spin button</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>isVisible</code> - - true means the spin button is visible; false means the spin |
| button is hidden</dd></dl> |
| </li> |
| </ul> |
| <a name="setFormatString(java.lang.String, org.odftoolkit.odfdom.dom.attribute.office.OfficeValueTypeAttribute.Value, java.util.Locale)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFormatString</h4> |
| <pre>protected void setFormatString(<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> formatStr, |
| org.odftoolkit.odfdom.dom.attribute.office.OfficeValueTypeAttribute.Value type, |
| <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> locale)</pre> |
| <div class="block">Set the format string of the field. |
| <p> |
| This function only works for float, date, time and percentage, otherwise an |
| <a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang"><code>IllegalArgumentException</code></a> will be thrown. |
| <p> |
| For value type float and percentage, the <code>formatStr</code> must follow the encoding |
| rule of <a href="http://download.oracle.com/javase/6/docs/api/java/text/DecimalFormat.html?is-external=true" title="class or interface in java.text"><code><code>java.text.DecimalFormat</code></code></a>. |
| For value type date and time, the <code>formatStr</code> must follow the encoding |
| rule of <a href="http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><code><code>java.text.SimpleDateFormat</code></code></a>. |
| <p> |
| <blockquote> |
| <table border=0 cellspacing=3 cellpadding=0 summary="Chart showing ValueType, Distinguish Symbol |
| and Distinguish Priority."> |
| <tr bgcolor="#ccccff"> |
| <th align=left>ValueType |
| <th align=left>Distinguish Symbol |
| <th align=left>Distinguish Priority |
| <tr valign=top> |
| <td>percentage |
| <td>% |
| <td>1 |
| <tr valign=top> |
| <td>time |
| <td>H, k, m, s, S |
| <td>2 |
| <tr valign=top> |
| <td>date |
| <td>y, M, w, W, D, d, F, E, K, h |
| <td>3 |
| <tr valign=top> |
| <td>float |
| <td>#, 0 |
| <td>4 |
| </table> |
| </blockquote> |
| If adaptive failed, an <a href="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a> will be thrown. |
| <p></div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>formatStr</code> - the cell need be formatted as this specified format string.</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>formatStr</code> is null or the cell value type is supported.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html?is-external=true" title="class or interface in java.text"><code>SimpleDateFormat</code></a>, |
| <a href="http://download.oracle.com/javase/6/docs/api/java/text/DecimalFormat.html?is-external=true" title="class or interface in java.text"><code>DecimalFormat</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getFormatString(org.odftoolkit.odfdom.dom.attribute.office.OfficeValueTypeAttribute.Value)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFormatString</h4> |
| <pre>public <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> getFormatString(org.odftoolkit.odfdom.dom.attribute.office.OfficeValueTypeAttribute.Value typeValue)</pre> |
| <div class="block">Get the format string of the field.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the format string of the field</dd></dl> |
| </li> |
| </ul> |
| <a name="getSimpleIterator(org.odftoolkit.simple.form.Form)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getSimpleIterator</h4> |
| <pre>public static <a href="http://download.oracle.com/javase/6/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util">Iterator</a><<a href="../../../../org/odftoolkit/simple/form/FormControl.html" title="class in org.odftoolkit.simple.form">FormControl</a>> getSimpleIterator(<a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface in org.odftoolkit.simple.form">Form</a> container)</pre> |
| <div class="block">Get a simple iterator for Field.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>container</code> - - an instance of form where to traverse the date fields</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/Field.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/DateField.html" title="class in org.odftoolkit.simple.form"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/odftoolkit/simple/form/Form.html" title="interface 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/Field.html" target="_top">Frames</a></li> |
| <li><a href="Field.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: </li> |
| <li>Nested | </li> |
| <li><a href="#fields_inherited_from_class_org.odftoolkit.simple.form.FormControl">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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 © 2010-2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.</small></p> |
| </body> |
| </html> |
