INTRO SPECS TUTORIALS RESOURCES TOOLS ABOUT US CONTACT US
UIML v1.0 UIML v2.0
 

UIML v2.0
Draft Spec
DTD
Examples
Vocabularies

UIML v1.0
Tags
Components
Attributes

UIML Interface Components (UIML 1.0)

TextArea

Toolkit:

java.awt

Description:

A region which can display multiple lines of text, which may or may not be editable. TextAreas may have either or both horizontal and vertical scrollbars; use the SCROLLBAR attribute to set these. If a TextArea has no horizontal scrollbar (that is, its SCROLLBAR attribute is set to NONE or VERTICAL_ONLY), then each "\n" in its content is treated like a carriage return/line feed, and forces remaining text to the next line.

ALIGNMENT

Allowed Values Meaning
Center, East, North, South, West With LAYOUT:BorderLayout: Where to place an interface component in its container. Only one component may go in each region. In this usage, ALIGNMENT is specified as an attribute of the component.
CENTER, EAST, NORTH, NORTHEAST, NORTHWEST, SOUTH, SOUTHEAST, SOUTHWEST, WEST With LAYOUT:GridBagLayout: Placement of interface component in its grid cell. In this usage, ALIGNMENT is specified as an attribute of the component.

BACKGROUND

Allowed Values Meaning
black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white, yellow Set background color to color name as defined in class java.awt.Color.
One of the color names from java.awt.Color (see above) followed by a - or a + (e.g., red- or blue+). A suffix of - means darken the color; a suffix of + means brighten the color. (These correspond to java.awt.Color.darken() and .brighten().)
0x<six hex digits> (e.g., 0xFF0000 for pure red). Set background color to RGB (red, green, blue) color specified as 0xRRBBGG, where RR denotes one of 256 intensities of red (00 to FF), BB denotes the intensity of blue, and and GG denotes the intensity of green.
A non-negative integer Set background to RGB color represented by a single integer. Bits 0-7 specify one of 256 intensities of blue; bits 8-15 green; and bits 16-23 red.
<float>,<float>,<float> where <float> is between 0 and 1 inclusive (e.g., .667,1,1 for pure blue). Set background to HSB (hue, saturation, brightness) color specified as a triple of numbers, where the first is hue, the second is saturation, and the third is brightness.
· Hue represents the rainbow (0 is white, near 0 are red, near 1 is magenta, and 1 is black).
· A saturation of 0 is either white or black, depending on brightness; a saturation of 1 is pure hue color.
· A brightness of 0 is black; a brightness of 1 is maximum color saturation.
activeCaption, activeCaptionBorder, activeCaptionText, control, controlDkShadow, controlHighlight, controlLtHighlight, controlShadow, controlText, desktop, inactiveCaption, inactiveCaptionBorder, inactiveCaptionText, info, infoText, menu, menuText, scrollbar, textHighlight, textHighlightText, textInactiveText, textText, window, windowBorder, windowText Set background to same color as corresponding system item. The allowed values are defined in class java.awt.SystemColor. (Note: these values work only on MS Windows platforms.)

COLUMNS

Allowed Values Meaning
A positive integer With TextArea and TextField: width of the component, in characters. In this usage, COLUMNS is specified as an attribute of the component.

CONTENT

Allowed Values Meaning
A string In TextArea and TextField: initial text to be displayed.

EDITABLE

Allowed Values Meaning
true, false Whether the text can be edited by the user. If true, the text can be edited (default).

ENABLED

Allowed Values Meaning
true, false If true, enables the component; otherwise, disables it. Default is true.

FILL

Allowed Values Meaning
NONE, BOTH, HORIZONTAL, VERTICAL Which direction the user interface component should grow in, when its container is resized and the grid cell size exceeds the user interface component size. FILL is specified as an attribute of the component.

FONT_NAME

Allowed Values Meaning
Dialog, DialogInput, Monospaced, SansSerif, Serif Generic name of font, which is mapped to a specific font on the platform on which Render runs (e.g., sansserif might be mapped to Helvetica).

FONT_SIZE

Allowed Values Meaning
A positive integer Font size, in points.

FONT_STYLE

Allowed Values Meaning
PLAIN, BOLD, ITALIC, BOLDITALIC Font style (bold, italic, etc.)

FOREGROUND

Allowed Values Meaning
black, blue, cyan, darkGray, gray, green, lightGray, magenta, orange, pink, red, white, yellow Set foreground color to color name as defined in class java.awt.Color.
One of the color names from java.awt.Color (see above) followed by a - or a + (e.g., red- or blue+). A suffix of - means darken the color; a suffix of + means brighten the color. (These correspond to java.awt.Color.darken() and .brighten().)
0x<six hex digits> (e.g., 0xFF0000 for pure red). Set foreground color to RGB (red, green, blue) color specified as 0xRRBBGG, where RR denotes one of 256 intensities of red (00 to FF), BB denotes the intensity of blue, and and GG denotes the intensity of green.
A non-negative integer Set foreground to RGB color represented by a single integer. Bits 0-7 specify one of 256 intensities of blue; bits 8-15 green; and bits 16-23 red.
<float>,<float>,<float> where <float> is between 0 and 1 inclusive (e.g., .667,1,1 for pure blue). Set foreground to HSB (hue, saturation, brightness) color specified as a triple of numbers, where the first is hue, the second is saturation, and the third is brightness.
· Hue represents the rainbow (0 is white, near 0 are red, near 1 is magenta, and 1 is black).
· A saturation of 0 is either white or black, depending on brightness; a saturation of 1 is pure hue color.
· A brightness of 0 is black; a brightness of 1 is maximum color saturation.
activeCaption, activeCaptionBorder, activeCaptionText, control, controlDkShadow, controlHighlight, controlLtHighlight, controlShadow, controlText, desktop, inactiveCaption, inactiveCaptionBorder, inactiveCaptionText, info, infoText, menu, menuText, scrollbar, textHighlight, textHighlightText, textInactiveText, textText, window, windowBorder, windowText Set foreground to same color as corresponding system item. Meaning of the allowed values is defined in class java.awt.SystemColor. (Note: these values work only on MS Windows platforms.)

GRID_HEIGHT

Allowed Values Meaning
A positive integer Interface component height, in rows.
REMAINDER Set component height to the number of rows remaining in the grid.

GRID_WIDTH

Allowed Values Meaning
A positive integer Interface component width, in columns.
REMAINDER Set component width to the number of columns remaining in the grid.

HEIGHT

Allowed Values Meaning
A positive integer Sets the component's height, in pixels. HEIGHT settings are guaranteed to be used only for components whose container is using AbsoluteLayout. Otherwise, HEIGHT is a preference that the layout manager may or may not elect to use.

LEFT

Allowed Values Meaning
A non-negative integer. Distance, in pixels, from the left edge of the container to the left edge of the component. Overrides LOCATION.

Note this attribute measures from the outside edge of the container. So it's possible to position components so they're partially or completely hidden by the window's title bar.

Note also that when using AbsoluteLayout, all components' position must be specified with either LOCATION or the LEFT and TOP attributes.

LOCATION

Allowed Values Meaning
Two positive integers, separated by a comma (e.g., 125,73) Location of the top left corner of the component, in pixels, where 0,0 is the top left corner of the container. LEFT and TOP override LOCATION.

Note this attribute measures from the outside edge of the container. So it's possible to position components so they're partially or completely hidden by the window's title bar.

Note also that when using AbsoluteLayout, all components' position must be specified with either LOCATION or the LEFT and TOP attributes.

RENDERING

Allowed Values Meaning
Button, Choice, Label, List, Panel, ScrollPane, TextArea, TextField Inserts a java.awt component into a parent component. The parent component must be rendered as a Frame, Panel, or ScrollPane.

ROWS

Allowed Values Meaning
A positive integer With TextArea: height of the component, in rows. In this usage, ROWS is specified as an attribute of the component.

SCROLLBARS

Allowed Values Meaning
BOTH, HORIZONTAL_ONLY, NONE, VERTICAL_ONLY Specifies which scrollbars should be attached to the component. Default is BOTH. Using SCROLLBARS requires explicitly defining the component's CONTENT, COLUMNS, and ROWS attributes.

SIZE

Allowed Values Meaning
Two positive integers, separated by a comma (e.g., 125,73) Sets the interface component's size, in pixels. This attribute is implemented:

- for components whose container's LAYOUT is AbsoluteLayout, and

- for Frames, regardless of layout.

Otherwise SIZE is a preference that the layout manager may or may not elect to use.

Note also that when using AbsoluteLayout, all components' size must be specified with the SIZE attribute.

TOP

Allowed Values Meaning
A non-negative integer Distance, in pixels, from the top edge of the container to the top edge of the component. Overrides LOCATION.

Note this attribute measures from the outside edge of the container. So it's possible to position components so they're partially or completely hidden by the window's title bar.

Note also that when using AbsoluteLayout, all components' position must be specified with either LOCATION or the LEFT and TOP attributes.

VISIBLE

Allowed Values Meaning
true, false Specifies whether to show the user interface component (true shows; false hides). The default is true.

WIDTH

Allowed Values Meaning
A positive integer Sets the component's width, in pixels. WIDTH settings are guaranteed to be used only for components whose container is using AbsoluteLayout. Otherwise, WIDTH is a preference that the layout manager may or may not elect to use.

XPAD

Allowed Values Meaning
A positive integer Amount of blank space, in pixels, added to left and right side of the interface component. XPAD is specified as an attribute of the component.

XPLACE

Allowed Values Meaning
A positive integer The column number in which to locate the interface component. In this usage, XPLACE is specified as an attribute of the component.
RELATIVE Positions the component in sequence following its peers. In this usage, XPLACE is specified as an attribute of the component.

XWEIGHT

Allowed Values Meaning
A float between 0 and 1 If 0: Do not give the interface component extra space if window is resized.

If >0: Give the interface component extra vertical space as window is resized vertically; magnitude determines amount of space allocated relative to other interface component with positive XWEIGHTs.

XWEIGHT is specified as an attribute of the component.

YPAD

Allowed Values Meaning
A positive integer Amount of blank space, in pixels, added to above and below the interface component. YPAD is specified as an attribute of the component.

YPLACE

Allowed Values Meaning
A positive integer The row number in which to locate the interface component. In this usage, YPLACE is specified as an attribute of the component.
RELATIVE Positions the component in sequence following its peers. In this usage, YPLACE is specified as an attribute of the component.

YWEIGHT

Allowed Values Meaning
A float between 0 and 1 If 0: Do not give the interface component extra space if window is resized.

If >0: Give the interface component extra horizontal space as window is resized horizontally; magnitude determines amount of space allocated relative to other interface components with positive YWEIGHTs.

YWEIGHT is specified as an attribute of the component.

 

© 1999-2000 UIML.org (all rights reserved)