A
JTextTerm
is the Swing version of the custom Yoix component that can be used
as a simple line orientated terminal emulator.
Yoix programs normally interact with a
JTextTerm
using event handlers and by reading or writing the following fields:
| afterNewline |
A
Function
that is called whenever it is not
NULL,
right after each new line of text is displayed in the textterm.
| | alignment |
An
int
that controls the positioning of the text in the textterm.
The value should be
LEFT,
CENTER,
or
RIGHT,
which are all defined in
yoix.swing.
Reading returns the current alignment.
Writing immediately repaints the text using the new alignment.
| | autotrim |
An
int
that is
1
when white space is automatically trimmed from both ends of every string
read from or written to the
text
field, and
0
otherwise.
| | background |
The
Color
that is used to paint the background of the textterm.
Reading returns a snapshot of the current color.
Writing immediately changes the background to the new color.
Storing
NULL
in
background
is special and means use the background of the nearest component
that contains the textterm and was assigned a background color other than
NULL;
if no component qualifies the textterm uses
VM.screen.background.
An
Object,
usually a
Border,
Insets,
Number,
or
String
that describes the border that is drawn around this textterm.
A
NULL
value, which is the default, means no border.
A
border
that is an
Insets
or
Number
is handled differently than most other Swing components,
because it is used, in combination with the
insets
field, to set the extent of the highlighted border,
in units of 72 dots per inch, that is drawn around the textterm.
A
border
that is a
String
is a quick way to surround this textterm with a border that uses the
String
as its title.
Reading returns a snapshot of the current border.
Writing immediately sets the textterm's border to the new value.
| | bordercolor |
The base
Color
that is used to pick the shadow colors for the highlighted border.
The textterm's background is used when bordercolor is
NULL.
Reading returns a snapshot of the current color.
Writing immediately changes the bordercolor to the new color.
| | cellsize |
A
Dimension
that measures distances in units of 72 dots per inch
with a
height
field that is the distance between adjacent lines of text,
and a
width
that is an estimate of the distance between adjacent characters.
Reading returns a snapshot of the current cellsize.
Writing is not allowed and will result in an
invalidaccess
error.
| | columns |
An
int
that specifies the number of columns in a textterm.
Layout managers usually get the final say, so setting
columns
should be viewed as a request that will not always be honored.
Reading returns the number of columns currently used by the textterm.
Writing tries to change the number of columns used by the textterm.
| | cursor |
An
Object
that should be an
int,
Image,
or
String
that selects the cursor shown when the pointer is over the textterm.
A
cursor
that is an
int
should be one of the cursors defined in the
yoix.awt.Cursor
dictionary.
A
cursor
that is an
Image
can describe the cursor using its
size
and
hotspot
fields and often draws it using its
paint
function.
A
cursor
that is a
String
should be the name of a cursor that is already defined in
yoix.awt.Cursor
or the name a local a file or URL that contains a GIF or JPEG image
that will be used as the cursor.
Reading returns the current cursor.
Writing immediately changes the textterm's cursor to the new value.
Storing
STANDARD_CURSOR
(the default) or
NULL
in
cursor
is special and means use the cursor assigned to the nearest component
that contains the textterm and was assigned a cursor other than
STANDARD_CURSOR;
if no component qualifies the textterm uses
DEFAULT_CURSOR.
| | doublebuffered |
An
int
that is
1
when the textterm uses double-buffering to draw itself,
0
when it does not, and starts with a default value that is
selected by Java for the textterm.
Reading returns the current double-buffering behavior.
Writing immediately sets the textterm's double-buffering behavior to the new value.
Note that double-buffering may be required when transparent components are used.
| | dragenabled |
An
int
that should be set to
1
when this textterm wants to use the automatic drag handling that Swing provides
for some components, and
0
(the default)
when it does not.
Components that do not provide automatic drag handling always return
0
when their
dragenabled
field is read, so storing
1
in
dragenabled
should only be viewed as a request for a service that may not be available.
Swing components can always take complete control of their drag and drop
handling using their
transferhandler
field or special drag and drop event handlers.
| | edit |
An
int
that is
1
when the contents of the textterm can be changed, and
0
otherwise.
Reading returns the current edit flag.
Writing immediately sets the textterm's edit flag to the new state.
| | enabled |
An
Object
that is
1
when the textterm can respond to user input,
0
when it can not respond, and
NULL
(the default)
when the textterm inherits the value from the nearest lightweight container,
like a
JPanel,
that contains the textterm and has its
enabled
field set to something other than
NULL.
The top-level application window that contains the textterm always gets the
final say, so disabling that window always disables the textterm.
Reading returns the current state.
Writing immediately sets the textterm's state to the new value.
| | extent |
A
Dimension
that measures distances in units of 72 dots per inch
with a
height
field that is the vertical size of all the lines of text,
and a
width
that is the horizontal size of the longest line of text.
Reading returns a snapshot of the current extent.
Writing is not allowed and will result in an
invalidaccess
error.
| | focusable |
An
int
that is non-zero (the default)
when the textterm can accept the keyboard focus and zero
when it can not.
Reading returns the textterm's current focusable state.
Writing immediately changes the textterm's focusable state to the new value,
which means the focus is automatically transferred if the new value is zero
and the textterm is the current focus owner.
| | focusowner |
A read-only
int
that is non-zero when the textterm has the focus.
| | font |
The
Font,
or font name if it is a
String,
used to paint the text displayed by the textterm.
Reading returns a snapshot of the current font.
Writing immediately repaints the text in the new font.
| | foreground |
The
Color
used to paint the text displayed by the textterm.
Reading returns a snapshot of the current color.
Writing immediately repaints the text in the new color.
Storing
NULL
in
foreground
is special and means use the foreground of the nearest component
that contains the textterm and was assigned a foreground color other than
NULL;
if no component qualifies the textterm uses
VM.screen.foreground.
| | insets |
An
Object,
usually an
Insets
or
Number,
that sets margins around the textterm that determine how close text
comes to the edges.
In addition,
insets
also determines the maximum size of the highlighted border in any direction,
independent of the values stored in
border.
An
insets
that is a number is an easy way to describe a uniform margin.
Reading returns a snapshot of the current insets.
Writing immediately sets the insets to the new value.
| | ipad |
An
Insets
that measures distances in units of 72 dots per inch
that adjusts the vertical margins at the top and bottom of each line displayed
by the textterm according to the values stored in
ipad.top
and
ipad.bottom.
Adjustments corresponding to
ipad.left
and
ipad.right
have not been implemented yet.
Reading returns a snapshot of the current padding.
Writing immediately repaints the text using the new padding.
| | layer |
An
int,
often a small number between 0 and 99,
that identifies the depth of this textterm when it is added to a
JLayeredPane
or
JDesktopPane.
Components assigned to lower numbered layers are drawn before
the components in higher numbered layers.
Writing immediately changes the textterm's layer, which usually means the
JLayeredPane
or
JDesktopPane
that contains the textterm will be repainted.
| | location |
A
Point
that determines the location of the textterm
in a coordinate system that has its origin at the upper left corner
of the container closest to the textterm (in the component hierarchy)
that actually contains it, positive x to the right, positive y down,
and a resolution of 72 dots per inch.
Reading returns a snapshot of the current location.
Writing is allowed, but layout managers usually get the final say, so setting
location
should be viewed as a request that may not be honored.
| | nextfocus |
An
Object
that identifies the component that receives the focus after this textterm
when the focus traverses from one component to the next
(usually by means of the keyboard
TAB
character).
When
nextfocus
is a
String
it is assumed to be the tag associated with the target component,
which must belong to the same top-level container (e.g., the same
JFrame)
as this textterm.
A
NULL
value means the component that gets the focus after this textterm will be
selected by Java's default focus traversal policy.
Reading returns the value last stored or
NULL
if the value was a
String
that did not reference a component.
Writing immediately changes the component that gets the focus after this textterm.
| | opaque |
An
Object
that is
1
when the textterm is opaque,
0
when it is transparent, and
NULL
(the default)
when the textterm inherits the value from the nearest component that
contains the textterm and has its
opaque
field set to something other than
NULL.
| | origin |
A
Point
that is the location of the upper left corner of the printable area
(i.e., left corner plus insets) of the textterm in a coordinate
system that has its origin at the upper left corner of the first line
of text, positive x to the right, positive y down, and a resolution
of 72 dots per inch.
Reading returns a snapshot of the current origin.
Writing immediately sets the origin to the new value.
| | popup |
A
JPopupMenu
that is associated with the textterm.
Reading returns the current popup menu.
Writing immediately shows the popup menu at the point in the textterm's coordinate
system specified by the popup menu's
location
field, assuming of course that the textterm is showing on the screen.
Storing
TRUE
in the popup menu's
visible
field, which was added in release 1.2.0, is an easy way to show the
popup menu that currently belongs to the textterm.
| | preferredsize |
A
Dimension
that is used by layout managers when they need to know the textterm's
preferred size in units of 72 dots per inch.
A
NULL
value means the textterm has no preference.
A non-positive height or width is allowed and simply means the textterm
has no preference for that dimension.
Reading returns the current preferred size.
Writing changes the preferred size and immediately notifies
root.layoutmanager,
which means the components contained in
root
may be repositioned and resized.
| | prompt |
A
String
that is printed at the start of each new line of text that is displayed
in the textterm.
Reading returns the current prompt.
Writing changes the prompt for any lines of text that are displayed in
the textterm following the change.
| | requestfocus |
An
int
that can be used to request or transfer the keyboard focus.
Storing a non-zero value in
requestfocus
tries to get the focus.
Storing
0
tries to transfer the focus.
Reading
requestfocus
does not currently return any useful information.
| | requestfocusenabled |
An
int
that is
1
(the default)
when actions, like mouse clicks or changes to the
requestfocus
field, can steal the keyboard focus and
0
when they can not.
Note that this field does not affect acceptance of the keyboard focus
during normal focus traversal.
Reading returns the current state.
Writing immediately sets the textterm's state to the new value.
| | root |
An
Object
that is automatically updated by the interpreter's layout machinery
so it is always the top-level object that contains the textterm.
For example, put a textterm in a panel and
root
will be set to that panel;
add the panel to a frame and the textterm's
root
field will be set to that frame.
A textterm's event handlers can use
root
when they need to interact with the other components in the container.
| | rows |
An
int
that specifies the number of rows in a textterm.
Layout managers usually get the final say, so setting
rows
should be viewed as a request that will not always be honored.
Reading returns the number of rows currently used by the textterm.
Writing tries to change the number of rows used by the textterm.
| | showing |
A read-only
int
that is non-zero when the textterm is showing on the screen.
| | size |
A
Dimension
that determines the size of the textterm
in units of 72 dots per inch.
Reading returns a snapshot of the current size.
Writing is allowed, but layout managers usually get the final say, so setting
size
should be viewed as a request that may not be honored.
| | state |
An
int
that controls how the border of the textterm, if there is one,
is drawn.
When state is
0
the left and top parts of the border are drawn in a brighter
color than the right and bottom parts, which makes it look like
the interior of the textterm is raised.
The border colors are reversed when state is
1,
which makes it look like the interior of the textterm is depressed.
| | subtext([int offset[, int length]]) |
A built-in that returns the current text within the given range.
When absent,
offset
defaults to the zero position and
length
defaults to the length from the offset to the end of the current text.
| | syncViewport(Rectangle viewport, Dimension extent, Dimension cellsize) |
A
Function
that is called whenever it is not
NULL
and a change, like a new font or a resize,
modifies the appearance of the text that is displayed in the textterm.
The function should use the
viewport,
extent,
and
cellsize
arguments to do whatever is required to synchronize other components,
like scrollbars, to the textterm.
| | tag |
A
String
used to identify the textterm that is either supplied when
the textterm is declared, or automatically generated otherwise.
Add a textterm to a container, like a
JFrame
or
JPanel,
and the interpreter's layout machinery updates the
root
field so it points at the top-level container and then adds the textterm, as
tag,
to the
root.components
dictionary.
| | text |
A
String
of characters that is displayed in the textterm.
Reading returns the current text.
Writing immediately paints the new text.
| | tooltiptext |
A
String
of characters that is displayed in a tightly sized pop-up window that
appears near the cursor whenever the cursor lingers over the textterm.
Setting this value to
NULL
(the default)
disables the tooltip mechanism.
Reading returns the current tooltip text.
Writing immediately sets the new tooltip text.
| | transferhandler |
An
Object
that should be a
TransferHandler
or
String
that determines how the textterm handles data transfer operations
like drag and drop.
A value that is a
String
but not
""
means the field named by the
String
should be used as the source and sink of the data that is transferred by
the textterm.
The result is the same as assigning the
String
to the
property
field in a
TransferHandler
and then assigning that
TransferHandler
to
transferhandler.
The empty
String
""
is special and refers to the
TransferHandler
that Swing uses for automatic drag handling, if there is one.
Swing components that provide automatic drag handling start out with a
transferhandler
field that is not
NULL,
but the automatic drag handling is not enabled until
1
is stored in
dragenabled.
Swing components that provide their own drag and drop event handlers
currently must store
NULL
in
transferhandler
before those event handlers will start working.
| | viewport |
An
Rectangle
that completely describes the printable area of the textterm
in a coordinate system that has its origin at the upper left corner
of the first line of text, positive x to the right, positive y down,
and a resolution of 72 dots per inch.
In other words, the
x
and
y
fields match the corresponding fields in
origin,
while
height
and
width
give the dimensions of the printable area of the textterm.
Reading returns a snapshot of the current viewport.
Writing is not allowed and will result in an
invalidaccess
error.
| | visible |
An
int
that is
1
when the textterm is visible, and
0
otherwise.
Reading returns the current visibility.
Writing immediately sets the textterm's visibility to the new state.
|
Several permanent fields have not been documented and should not be
used in Yoix applications.
Event handlers are functions that must be added to a textterm when it is
declared.
The handlers that work with textterms are listed below;
the names should be familiar if you have done some Java programming.
The
actionPerformed
and
itemStateChanged
event handlers are only for menus.
| |
| Event Handlers: |
actionPerformed,
componentHidden,
componentMoved,
componentResized,
componentShown,
dragDropEnd,
dragEnter,
dragExit,
dragGestureRecognized,
dragMouseMoved,
dragOver,
drop,
dropActionChanged,
focusGained,
focusLost,
invocationRun,
itemStateChanged,
keyPressed,
keyReleased,
keyTyped,
mouseClicked,
mouseDragged,
mouseEntered,
mouseExited,
mouseMoved,
mousePressed,
mouseReleased,
mouseWheelMoved
| | |
| Example: |
The program,
import yoix.*.*;
JFrame f = {
Array layout = {
new JTextTerm {
String tag = "received";
String prompt = "> ";
Color background = Color.white;
Color bordercolor = Color.red;
int insets = 6;
int border = 3;
int state = TRUE;
int edit = FALSE;
}, CENTER,
new JTextTerm {
String tag = "sent";
String prompt = ">> ";
Color background = Color.white;
Color bordercolor = Color.green;
int insets = 6;
int border = 3;
int state = TRUE;
int edit = TRUE;
int rows = 5;
afterNewline(text) {
if (strcmp(text, "QUIT") == 0)
exit(0);
else appendText(root.components.received,
text + "\n");
}
}, SOUTH,
};
};
f.visible = TRUE;
uses the
afterNewline
function to copy lines from the textterm with the red border to the
textterm with the green border.
| | |
| See Also: |
appendText,
BevelBorder,
Border,
EmptyBorder,
EtchedBorder,
invokeLater,
JButton,
JCanvas,
JCheckBox,
JCheckBoxMenuItem,
JChoice,
JColorChooser,
JComboBox,
JDesktopPane,
JDialog,
JFileChooser,
JFileDialog,
JFrame,
JInternalFrame,
JLabel,
JLayeredPane,
JList,
JMenu,
JMenuBar,
JMenuItem,
JPanel,
JPasswordField,
JPopupMenu,
JProgressBar,
JRadioButton,
JRadioButtonMenuItem,
JScrollBar,
JScrollPane,
JSeparator,
JSlider,
JSplitPane,
JTabbedPane,
JTable,
JTextArea,
JTextCanvas,
JTextField,
JTextPane,
JToggleButton,
JToolBar,
JTree,
JWindow,
LineBorder,
MatteBorder,
postEvent,
SoftBevelBorder,
TransferHandler
|
|
