| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_45) on Tue Mar 28 22:15:33 CEST 2017 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| Control (Simple ODF v0.8.2-incubating - http://odftoolkit) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2017-03-28"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Control (Simple ODF v0.8.2-incubating - http://odftoolkit)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Control.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/odftoolkit/simple/draw/AbstractTextboxContainer.html" title="class in org.odftoolkit.simple.draw"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/odftoolkit/simple/draw/ControlContainer.html" title="interface in org.odftoolkit.simple.draw"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/odftoolkit/simple/draw/Control.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Control.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.odftoolkit.simple.draw</FONT> |
| <BR> |
| Class Control</H2> |
| <PRE> |
| <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> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">org.odftoolkit.simple.Component</A> |
| <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.odftoolkit.simple.draw.Control</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>Control</B><DT>extends <A HREF="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</A></DL> |
| </PRE> |
| |
| <P> |
| This class represents control object, a shape that is linked to a control |
| inside an form. It provides methods to get/set control properties, content, |
| and styles. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>Since:</B></DT> |
| <DD>0.8</DD> |
| </DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#Control(org.odftoolkit.odfdom.dom.element.draw.DrawControlElement)">Control</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/draw/DrawControlElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.draw">DrawControlElement</A> element)</CODE> |
| |
| <BR> |
| </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#getContainerElement()">getContainerElement</A></B>()</CODE> |
| |
| <BR> |
| Get the container element which contains this control.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/odftoolkit/simple/draw/Control.html" title="class in org.odftoolkit.simple.draw">Control</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#getInstanceof(org.odftoolkit.odfdom.dom.element.draw.DrawControlElement)">getInstanceof</A></B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/draw/DrawControlElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.draw">DrawControlElement</A> element)</CODE> |
| |
| <BR> |
| Get an instance of control according to a DrawControlElement.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/draw/DrawControlElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.draw">DrawControlElement</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#getOdfElement()">getOdfElement</A></B>()</CODE> |
| |
| <BR> |
| Get the instance of DrawControlElement which represents this control.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/draw/FrameRectangle.html" title="class in org.odftoolkit.simple.draw">FrameRectangle</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#getRectangle()">getRectangle</A></B>()</CODE> |
| |
| <BR> |
| Return the rectangle used by this control</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../org/odftoolkit/simple/draw/ControlStyleHandler.html" title="class in org.odftoolkit.simple.draw">ControlStyleHandler</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#getStyleHandler()">getStyleHandler</A></B>()</CODE> |
| |
| <BR> |
| Return the style handler for this control</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../org/odftoolkit/simple/draw/Control.html" title="class in org.odftoolkit.simple.draw">Control</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#newDrawControl(org.odftoolkit.simple.draw.ControlContainer)">newDrawControl</A></B>(<A HREF="../../../../org/odftoolkit/simple/draw/ControlContainer.html" title="interface in org.odftoolkit.simple.draw">ControlContainer</A> container)</CODE> |
| |
| <BR> |
| Create an instance of control and and append it at the end of a container |
| element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#remove()">remove</A></B>()</CODE> |
| |
| <BR> |
| Remove the shape control from the container.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#setAchorType(org.odftoolkit.simple.style.StyleTypeDefinitions.AnchorType)">setAchorType</A></B>(<A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.AnchorType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.AnchorType</A> achorType)</CODE> |
| |
| <BR> |
| Set how a form control is bound to a text document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#setControl(java.lang.String)">setControl</A></B>(<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> formControlId)</CODE> |
| |
| <BR> |
| Set a control within a form that is linked to this control shape by its |
| ID.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#setFormatString(java.lang.String, java.lang.String)">setFormatString</A></B>(<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, |
| <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> type)</CODE> |
| |
| <BR> |
| Set the format string of the input control.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/odftoolkit/simple/draw/Control.html#setRectangle(org.odftoolkit.simple.draw.FrameRectangle)">setRectangle</A></B>(<A HREF="../../../../org/odftoolkit/simple/draw/FrameRectangle.html" title="class in org.odftoolkit.simple.draw">FrameRectangle</A> rectangle)</CODE> |
| |
| <BR> |
| Set the rectangle used by this control</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.odftoolkit.simple.Component"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.odftoolkit.simple.<A HREF="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>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></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><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></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="Control(org.odftoolkit.odfdom.dom.element.draw.DrawControlElement)"><!-- --></A><H3> |
| Control</H3> |
| <PRE> |
| public <B>Control</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/draw/DrawControlElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.draw">DrawControlElement</A> element)</PRE> |
| <DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getContainerElement()"><!-- --></A><H3> |
| getContainerElement</H3> |
| <PRE> |
| public <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/pkg/OdfElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.pkg">OdfElement</A> <B>getContainerElement</B>()</PRE> |
| <DL> |
| <DD>Get the container element which contains this control. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the container element.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getOdfElement()"><!-- --></A><H3> |
| getOdfElement</H3> |
| <PRE> |
| public <A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/draw/DrawControlElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.draw">DrawControlElement</A> <B>getOdfElement</B>()</PRE> |
| <DL> |
| <DD>Get the instance of DrawControlElement which represents this control. |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/odftoolkit/simple/Component.html#getOdfElement()">getOdfElement</A></CODE> in class <CODE><A HREF="../../../../org/odftoolkit/simple/Component.html" title="class in org.odftoolkit.simple">Component</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the instance of DrawControlElement</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="newDrawControl(org.odftoolkit.simple.draw.ControlContainer)"><!-- --></A><H3> |
| newDrawControl</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/simple/draw/Control.html" title="class in org.odftoolkit.simple.draw">Control</A> <B>newDrawControl</B>(<A HREF="../../../../org/odftoolkit/simple/draw/ControlContainer.html" title="interface in org.odftoolkit.simple.draw">ControlContainer</A> container)</PRE> |
| <DL> |
| <DD>Create an instance of control and and append it at the end of a container |
| element. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>container</CODE> - - the container element |
| <DT><B>Returns:</B><DD>a control instance</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getInstanceof(org.odftoolkit.odfdom.dom.element.draw.DrawControlElement)"><!-- --></A><H3> |
| getInstanceof</H3> |
| <PRE> |
| public static <A HREF="../../../../org/odftoolkit/simple/draw/Control.html" title="class in org.odftoolkit.simple.draw">Control</A> <B>getInstanceof</B>(<A HREF="http://incubator.apache.org/odftoolkit/odfdom/index.html/apidocs/org/odftoolkit/odfdom/dom/element/draw/DrawControlElement.html?is-external=true" title="class or interface in org.odftoolkit.odfdom.dom.element.draw">DrawControlElement</A> element)</PRE> |
| <DL> |
| <DD>Get an instance of control according to a DrawControlElement. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>element</CODE> - - an instance of DrawControlElement |
| <DT><B>Returns:</B><DD>an instance of DrawControlElement</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="remove()"><!-- --></A><H3> |
| remove</H3> |
| <PRE> |
| public boolean <B>remove</B>()</PRE> |
| <DL> |
| <DD>Remove the shape control from the container. |
| <p> |
| The resource is removed if it's only used by this object. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>true if the shape control is successfully removed; false if |
| otherwise.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getStyleHandler()"><!-- --></A><H3> |
| getStyleHandler</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/draw/ControlStyleHandler.html" title="class in org.odftoolkit.simple.draw">ControlStyleHandler</A> <B>getStyleHandler</B>()</PRE> |
| <DL> |
| <DD>Return the style handler for this control |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the style handler</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setControl(java.lang.String)"><!-- --></A><H3> |
| setControl</H3> |
| <PRE> |
| public void <B>setControl</B>(<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> formControlId)</PRE> |
| <DL> |
| <DD>Set a control within a form that is linked to this control shape by its |
| ID. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>formControlId</CODE> - - id of a form control</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setAchorType(org.odftoolkit.simple.style.StyleTypeDefinitions.AnchorType)"><!-- --></A><H3> |
| setAchorType</H3> |
| <PRE> |
| public void <B>setAchorType</B>(<A HREF="../../../../org/odftoolkit/simple/style/StyleTypeDefinitions.AnchorType.html" title="enum in org.odftoolkit.simple.style">StyleTypeDefinitions.AnchorType</A> achorType)</PRE> |
| <DL> |
| <DD>Set how a form control is bound to a text document. Default position |
| relative and alignment will be set. |
| |
| <p> |
| If the document is not text document, nothing will happen. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>achorType</CODE> - - the point at which a form control is bound to a text |
| document</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setRectangle(org.odftoolkit.simple.draw.FrameRectangle)"><!-- --></A><H3> |
| setRectangle</H3> |
| <PRE> |
| public void <B>setRectangle</B>(<A HREF="../../../../org/odftoolkit/simple/draw/FrameRectangle.html" title="class in org.odftoolkit.simple.draw">FrameRectangle</A> rectangle)</PRE> |
| <DL> |
| <DD>Set the rectangle used by this control |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>rectangle</CODE> - - the rectangle used by this control</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getRectangle()"><!-- --></A><H3> |
| getRectangle</H3> |
| <PRE> |
| public <A HREF="../../../../org/odftoolkit/simple/draw/FrameRectangle.html" title="class in org.odftoolkit.simple.draw">FrameRectangle</A> <B>getRectangle</B>()</PRE> |
| <DL> |
| <DD>Return the rectangle used by this control |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>- the rectangle used by this control</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="setFormatString(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| setFormatString</H3> |
| <PRE> |
| public void <B>setFormatString</B>(<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, |
| <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> type)</PRE> |
| <DL> |
| <DD>Set the format string of the input control. |
| <p> |
| This function only works for 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 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> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>formatStr</CODE> - -the input need be formatted as this specified format string.<DD><CODE>type</CODE> - - the type that need to be set |
| <DT><B>Throws:</B> |
| <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 value type is |
| supported.<DT><B>See Also:</B><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></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Control.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../org/odftoolkit/simple/draw/AbstractTextboxContainer.html" title="class in org.odftoolkit.simple.draw"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/odftoolkit/simple/draw/ControlContainer.html" title="interface in org.odftoolkit.simple.draw"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/odftoolkit/simple/draw/Control.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="Control.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2010-2017 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |
