Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<h3>Generated Object</h3>

<p>A javax.swing.JTextField is returned, unless the user passes in a subclass of JTextField as the value argument, in which case the value argument is returned.</p>

<h3>Value Argument</h3>

<p>The value argument can be either a JTextField, or a String.  If the value argument is a string it is treated as though it were passed in as the text attribute.</p>

<h3>Attributes</h3>

<p>See also: <a class="confluence-link" href="/display/GROOVY/SwingBuilder.JComponent" data-linked-resource-id="24576133" data-linked-resource-type="page" data-linked-resource-default-alias="SwingBuilder.JComponent" data-base-url="http://docs.codehaus.org">JComponent</a></p>

<h4>Declared in JTextField</h4>

<ul>
	<li>action &lt;Action&gt; the Action instance connected with this ActionEvent source</li>
	<li>columns &lt;int&gt; the number of columns preferred for display</li>
	<li>horizontalAlignment &lt;int&gt; Set the field alignment to LEFT, CENTER, RIGHT, LEADING (the default) or TRAILING</li>
	<li>scrollOffset &lt;int&gt; scrollOffset</li>
</ul>

<h4>Declared in javax.swing.text.JTextComponent</h4>

<ul>
	<li>caret &lt;javax.swing.text.Caret&gt; the caret used to select/navigate</li>
	<li>caretColor &lt;Color&gt; the color used to render the caret</li>
	<li>caretPosition &lt;int&gt; the caret position</li>
	<li>disabledTextColor &lt;Color&gt; color used to render disabled text</li>
	<li>document &lt;javax.swing.text.Document&gt; the text document model</li>
	<li>editable &lt;boolean&gt; specifies if the text can be edited</li>
	<li>focusAccelerator &lt;char&gt; accelerator character used to grab focus</li>
	<li>highlighter &lt;javax.swing.text.Highlighter&gt; object responsible for background highlights</li>
	<li>margin &lt;Insets&gt; desired space between the border and text area</li>
	<li>selectedText &lt;String&gt; selectedText</li>
	<li>selectedTextColor &lt;Color&gt; color used to render selected text</li>
	<li>selectionColor &lt;Color&gt; color used to render selection background</li>
	<li>selectionEnd &lt;int&gt; ending location of the selection.</li>
	<li>selectionStart &lt;int&gt; starting location of the selection.</li>
	<li>text &lt;String&gt; the text of this component</li>
</ul>

<h3>Content</h3>

<p>No child content is accepted in a textField.</p>

<h3>Usage</h3>

<p>The action connected to the textField is usually fired when the 'Enter' key is pressed by the user when the textField has keyboard focus.</p>

<h3>Examples</h3>

<h3>Observable Attributes</h3>

<ul>
	<li>text - via syntetic observation</li>
	<li>caret</li>
	<li>caretColor</li>
	<li>disabledTextColor</li>
	<li>document</li>
	<li>dragEnabled</li>
	<li>editable</li>
	<li>focusAccelerator</li>
	<li>highlighter</li>
	<li>keymap</li>
	<li>margin</li>
	<li>selectedTextColor</li>
	<li>selectionColor</li>
</ul>