moka.x
Class TextArea

java.lang.Object
  extended bymoka.lang.Object
      extended bymoka.event.EventListener
          extended bymoka.x.Component
              extended bymoka.x.CaptionedComponent
                  extended bymoka.x.TextArea
All Implemented Interfaces:
Captioned

public class TextArea
extends CaptionedComponent

TextArea class is a text entry component.

Since:
MDK1.0a

Field Summary
 boolean editable
          Is the text editable ?
 short maxLength
          The number of character this TextField should accept.
 int scrollLine
          The index of the first line.
 boolean vScrollVisible
          Is the vertical scroll bar should be visible ? Should be only read.
 boolean warp
          Should the words be warped ? Should be only read.
 
Fields inherited from class moka.x.Component
enabled, height, listen, mnemonic, next, parent, prev, visible, width, x, y
 
Fields inherited from interface moka.x.Captioned
caption, font
 
Constructor Summary
TextArea()
           
TextArea(java.lang.String caption)
           
 
Method Summary
 void paint()
          Paints the TextArea.
 void setScrollLine(int num)
          Sets the scroll position.
 void setVScrollVisible(boolean b)
          Sets if the vertical scroll bar should be visible.
 void setWarp(boolean b)
          Sets if the words should be warped.
 void use()
          This method is invoked by the GEM when the user interacts with the TextArea.
 
Methods inherited from class moka.x.CaptionedComponent
finalize
 
Methods inherited from class moka.x.Component
bottom, center, checkMnemonic, clean, eventTriggered, isCursorOver, left, move, onPaint, right, setBounds, setEnabled, setHeight, setMnemonic, setVisible, setWidth, setX, setY, toFront, top
 
Methods inherited from class moka.event.EventListener
eventTriggered
 
Methods inherited from class moka.lang.Object
equals, getClassName, toString
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface moka.x.Captioned
setCaption, setFont
 

Field Detail

maxLength

public short maxLength
The number of character this TextField should accept. Should be > 0.


warp

public boolean warp
Should the words be warped ? Should be only read.


vScrollVisible

public boolean vScrollVisible
Is the vertical scroll bar should be visible ? Should be only read. Use setVScrollVisible to set value.


scrollLine

public int scrollLine
The index of the first line. Should be only read. Use setScrollLine to set value.


editable

public boolean editable
Is the text editable ?

Constructor Detail

TextArea

public TextArea()

TextArea

public TextArea(java.lang.String caption)
Method Detail

setWarp

public void setWarp(boolean b)
Sets if the words should be warped.

Parameters:
b - true to specify that the words should be warped, false to specify that the words should not be warped

setVScrollVisible

public void setVScrollVisible(boolean b)
Sets if the vertical scroll bar should be visible.

Parameters:
b - true to specify that the vertical scroll bar should be visible

setScrollLine

public void setScrollLine(int num)
Sets the scroll position. In other words, the first line to be displayed by the TextArea.

Parameters:
num - the number of the first line (should be >= 0 and < to the total number of lines).

paint

public void paint()
Paints the TextArea.

Overrides:
paint in class Component

use

public void use()
This method is invoked by the GEM when the user interacts with the TextArea.

Overrides:
use in class Component