javax.microedition.lcdui
Class TextBox

java.lang.Object
  |
  +--javax.microedition.lcdui.Displayable
        |
        +--javax.microedition.lcdui.Screen
              |
              +--javax.microedition.lcdui.TextBox

public class TextBox

extends Screen

TextBox 클래스는 사용자가 텍스트를 입력하고 편집할 수 있는 Screen입니다.

TextBox는 객체에 언제든지 저장할 수 있는 문자의 최대 수(용량)를 나타내는 최대 크기를 가집니다. 이 제한은 TextBox 인스턴스가 구성될 때 즉, 사용자가 TextBox에서 텍스트를 편집하고 응용 프로그램이 내용을 수정하는 TextBox의 메소드를 호출할 때 적용됩니다. 최대 크기는 최대 저장 용량이며 주어진 시간에 표시될 수 있는 문자 수와는 관계가 없습니다. 문자 수가 표시되고 행과 열에 배열되는 방법은 장치마다 다릅니다.

구현 시 최대 크기를 경계로 할 수 있으며 실제로 지정되는 최대 크기는 응용 프로그램이 요청한 크기보다 작을 수 있습니다. 지정된 실제 값은 getMaxSize()가 반환하는 값에 반영됩니다. 방어적으로 작성된 응용 프로그램은 이 값을 요청한 최대 크기와 비교하고 이 값이 서로 다를 경우를 처리할 수 있어야 합니다.

TextBox에 포함된 텍스트는 한 번에 표시하기에 너무 많을 수도 있습니다. 이런 경우에는 구현 시 사용자 스크롤을 허용하여 텍스트의 모든 부분을 보고 편집할 수 있도록 합니다. 이 스크롤 작업은 응용 프로그램에 투명하게 발생합니다.

제약 조건이 TextField.ANY로 설정된 경우 텍스트는 줄 바꿈을 포함할 수 있습니다. 이에 따라 텍스트 표시가 줄 바꿈되고 사용자는 줄 바꿈 문자를 입력할 수 있어야 합니다.

TextBox에는 TextField와 동일한 입력 제약 조건 개념이 있습니다. TextBox 클래스에서 메소드의 constraints 매개 변수는 TextField 클래스에 정의된 상수를 사용합니다. 이러한 상수에 대한 정의는 TextField 클래스에서 입력 제약 조건의 설명을 참조하십시오. TextBox에는 실제 내용, 표시된 내용 등 TextField와 같은 개념이 동일한 섹션에 설명되어 있습니다.

TextBox에는 또한 TextField와 동일한 입력 모드 개념이 있습니다. 자세한 내용은 TextField 클래스에 있는 입력 모드의 설명을 참조하십시오.

Since:

MIDP 1.0

Constructor Summary

TextBox(String title, String text, int maxSize, int constraints)
주어진 제목 문자열, 초기 내용, 최대 문자 수 및 제약 조건을 사용하여 새 TextBox 객체를 만듭니다.

Method Summary

void	delete(int offset, int length) TextBox에서 문자를 삭제합니다.
int	getCaretPosition() 현재 입력 위치를 가져옵니다.
int	getChars(char[] data) TextBox의 내용을 색인 0에서 시작하는 문자 배열로 복사합니다.
int	getConstraints() TextBox의 현재 입력 제약 조건을 가져옵니다.
int	getMaxSize() TextBox에 저장될 수 있는 최대 크기(문자 수)를 반환합니다.
String	getString() 문자열 값으로 TextBox의 내용을 가져옵니다.
void	insert(char[] data, int offset, int length, int position) 문자 배열의 하위 범위를 TextBox의 내용에 삽입합니다.
void	insert(String src, int position) 문자열을 TextBox의 내용에 삽입합니다.
void	setChars(char[] data, int offset, int length) 문자 배열로부터 TextBox의 내용을 설정하여 이전 내용을 교체합니다.
void	setConstraints(int constraints) TextBox의 입력 제약 조건을 설정합니다.
void	setInitialInputMode(String characterSubset) 사용자가 이 TextBox의 편집을 시작할 때 사용되어야 할 입력 모드에 대한 힌트를 설정합니다.
int	setMaxSize(int maxSize) TextBox 내에 포함될 수 있는 최대 크기(문자 수)를 설정합니다.
void	setString(String text) 문자열 값으로 TextBox의 내용을 설정하여 이전 내용을 대체합니다.
int	size() 현재 TextBox 내에 저장된 문자 수를 가져옵니다.

Methods inherited from class javax.microedition.lcdui.Displayable

addCommand, getHeight, getTicker, getTitle, getWidth, isShown, removeCommand, setCommandListener, setTicker, setTitle, sizeChanged

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextBox

public TextBox(String title,
               String text,
               int maxSize,
               int constraints)

주어진 제목 문자열, 초기 내용, 최대 문자 수 및 제약 조건을 사용하여 새 TextBox 객체를 만듭니다. 텍스트 매개 변수가 null이면 TextBox는 공백으로 작성됩니다. maxSize 매개 변수는 0보다 커야 합니다. 초기 내용 문자열의 길이가 maxSize를 초과하면 IllegalArgumentException이 발생합니다. 하지만 구현 시 응용 프로그램이 요청한 것보다 작은 최대 크기를 할당할 수 있습니다. 이런 경우 내용의 길이가 새로 할당된 최대 크기를 초과하면 여기에 맞추기 위해 내용의 끝부분이 잘리고 예외가 발생하지 않습니다.

Parameters:

title - 디스플레이에 표시될 제목 텍스트

text - 텍스트 편집 영역의 초기 내용. 초기 내용이 없으면 null이 사용될 수 있습니다.

maxSize - 최대 용량(문자 수). 구현 시 경계 최대 용량을 제한할 수 있으며 실제로 할당되는 용량은 요청된 것보다 작을 수 있습니다. 방어적인 응용 프로그램은 getMaxSize()를 사용하여 제공된 실제 용량을 테스트합니다.

constraints - 입력 제약 조건을 참조하십시오.

Throws:

IllegalArgumentException - maxSize가 0 이하인 경우

IllegalArgumentException - constraints 매개 변수가 유효하지 않은 경우

IllegalArgumentException - text가 지정된 제약 조건에 적합하지 않은 경우

IllegalArgumentException - 문자열의 길이가 요청된 최대 용량을 초과할 경우

Method Detail

getString

public String getString()

문자열 값으로 TextBox의 내용을 가져옵니다.

Returns:

현재 내용

See Also:

setString(java.lang.String)

setString

public void setString(String text)

문자열 값으로 TextBox의 내용을 설정하여 이전 내용을 대체합니다.

Parameters:

text - TextBox의 새 값 또는 TextBox가 비어 있는 경우 null

Throws:

IllegalArgumentException - text가 현재의 입력 제약 조건에 적합하지 않을 경우

IllegalArgumentException - 텍스트가 현재 최대 용량을 초과하는 경우

See Also:

getString()

getChars

public int getChars(char[] data)

TextBox의 내용을 색인 0에서 시작하는 문자 배열로 복사합니다. 복사된 문자 뒤에 있는 배열 요소는 변경되지 않습니다.

Parameters:

data - 값을 받을 문자 배열

Returns:

복사된 문자 수

Throws:

ArrayIndexOutOfBoundsException - 배열이 내용에 비해 너무 짧을 경우

NullPointerException - data가 null인 경우

See Also:

setChars(char[], int, int)

setChars

public void setChars(char[] data,
                     int offset,
                     int length)

문자 배열로부터 TextBox의 내용을 설정하여 이전 내용을 교체합니다. 배열 색인 offset에서 시작하여 length 문자만큼의 data 배열 영역에서 문자가 복사됩니다. 데이터 배열이 null이면 TextBox가 공백으로 설정되고 다른 매개 변수는 무시됩니다.

offset 및 length 매개 변수는 문자 배열 data 내의 유효한 문자 범위를 지정해야 합니다. offset 매개 변수는 [0..(data.length)] 범위(포함)에 있어야 합니다. length 매개 변수는 음수가 아닌 정수여야 하며, 여기서 (offset + length) <= data.length입니다.

Parameters:

data - 문자 데이터 소스

offset - 복사할 문자 영역의 시작 부분

length - 복사할 문자 수

Throws:

ArrayIndexOutOfBoundsException - offset과 length는 데이터 배열 내의 유효한 범위를 지정하지 않습니다.

IllegalArgumentException - data가 현재의 입력 제약 조건에 적합하지 않을 경우

IllegalArgumentException - 텍스트가 현재 최대 용량을 초과하는 경우

See Also:

getChars(char[])

insert

public void insert(String src,
                   int position)

문자열을 TextBox의 내용에 삽입합니다. 문자열은 position 매개 변수가 나타내는 문자의 바로 앞에 삽입되며, 여기서 0은 TextBox 내용의 첫 문자를 지정합니다. position이 0 이하인 경우에는 내용의 시작 부분에 삽입되어 앞에 덧붙이는 결과가 됩니다. position이 내용의 현재 크기 이상인 경우에는 내용의 맨 뒤에 삽입되어 뒤에 추가하는 결과가 됩니다. 예를 들어, text.insert(s, text.size())는 문자열 s를 항상 현재 내용의 뒤에 추가합니다.

내용의 현재 크기는 삽입된 문자 수만큼 증가됩니다. 결과 문자열은 현재 최대 용량 이내로 맞춰져야 합니다.

응용 프로그램은 getCaretPosition() 메소드를 사용하여 현재 삽입 지점("캐럿")의 위치를 결정할 수 있는 문자 입력을 시뮬레이션해야 합니다. 예를 들어, text.insert(s, text.getCaretPosition())은 현재 캐럿 위치에 s문자열을 삽입합니다.

Parameters:

src - 삽입될 String

position - 삽입이 발생하는 위치

Throws:

IllegalArgumentException - 결과 내용이 현재의 입력 제약 조건에 유효하지 않은 경우

IllegalArgumentException - 삽입 시 현재 최대 용량을 초과하는 경우

NullPointerException - src가 null인 경우

insert

public void insert(char[] data,
                   int offset,
                   int length,
                   int position)

문자 배열의 하위 범위를 TextBox의 내용에 삽입합니다. offset 및 length 매개 변수는 삽입에 사용될 데이터 배열의 하위 범위를 나타냅니다. 그 이외의 동작은 insert(String, int)와 동일합니다.

offset 및 length 매개 변수는 문자 배열 data 내의 유효한 문자 범위를 지정해야 합니다. offset 매개 변수는 [0..(data.length)] 범위(포함)에 있어야 합니다. length 매개 변수는 음수가 아닌 정수여야 하며, 여기서 (offset + length) <= data.length입니다.

Parameters:

data - 문자 데이터 소스

offset - 복사할 문자 영역의 시작 부분

length - 복사할 문자 수

position - 삽입이 발생하는 위치

Throws:

ArrayIndexOutOfBoundsException - offset과 length는 데이터 배열 내의 유효한 범위를 지정하지 않습니다.

IllegalArgumentException - 결과 내용이 현재의 입력 제약 조건에 유효하지 않은 경우

IllegalArgumentException - 삽입 시 현재 최대 용량을 초과하는 경우

NullPointerException - data가 null인 경우

delete

public void delete(int offset,
                   int length)

TextBox에서 문자를 삭제합니다.

offset 및 length 매개 변수는 TextBox 내용 내의 유효한 문자 범위를 지정해야 합니다. offset 매개 변수는 [0..(size())] 범위(포함)에 있어야 합니다. length 매개 변수는 음수가 아닌 정수여야 하며, 여기서 (offset + length) <= size()입니다.

Parameters:

offset - 삭제되는 범위의 시작 부분

length - 삭제되는 문자 수

Throws:

IllegalArgumentException - 결과 내용이 현재의 입력 제약 조건에 유효하지 않은 경우

StringIndexOutOfBoundsException - offset과 length가 TextBox 내용 내의 유효한 범위를 지정하지 않는 경우

getMaxSize

public int getMaxSize()

TextBox에 저장될 수 있는 최대 크기(문자 수)를 반환합니다.

Returns:

최대 문자 크기

See Also:

setMaxSize(int)

setMaxSize

public int setMaxSize(int maxSize)

TextBox 내에 포함될 수 있는 최대 크기(문자 수)를 설정합니다. TextBox의 현재 내용이 maxSize보다 크면 내용이 여기에 맞게 잘립니다.

Parameters:

maxSize - 새 최대 크기

Returns:

할당된 최대 용량(요청된 것보다 작을 수 있음)

Throws:

IllegalArgumentException - maxSize가 0 이하인 경우

IllegalArgumentException - 잘려진 후 내용이 현재의 입력 제약 조건에 유효하지 않은 경우

See Also:

getMaxSize()

size

public int size()

현재 TextBox 내에 저장된 문자 수를 가져옵니다.

Returns:

문자 수

getCaretPosition

public int getCaretPosition()

현재 입력 위치를 가져옵니다. 일부 UI는 차단되어 사용자에게 필요한 캐럿 위치를 요청할 수도 있고, 단순히 현재 캐럿 위치를 반환할 수도 있습니다.

Returns:

현재 캐럿 위치. 시작 부분이면 0

setConstraints

public void setConstraints(int constraints)

TextBox의 입력 제약 조건을 설정합니다. TextBox의 현재 내용이 새 제약 조건과 일치하지 않으면 내용이 공백으로 설정됩니다.

Parameters:

constraints - 입력 제약 조건을 참조하십시오.

Throws:

IllegalArgumentException - 제약 조건 매개 변수의 값이 유효하지 않을 경우

See Also:

getConstraints()

getConstraints

public int getConstraints()

TextBox의 현재 입력 제약 조건을 가져옵니다.

Returns:

현재 제약 조건 값(입력 제약 조건 참조)

See Also:

setConstraints(int)

setInitialInputMode

public void setInitialInputMode(String characterSubset)

사용자가 이 TextBox의 편집을 시작할 때 사용되어야 할 입력 모드에 대한 힌트를 설정합니다. characterSubset 매개 변수는 구현 시 초기 입력 모드를 선택할 때 사용되는 유니코드 문자 하위 집합의 이름입니다. null이 전달되면 구현 시 기본 입력 모드를 선택해야 합니다.

입력 모드의 전체적인 설명은 입력 모드를 참조하십시오.

Parameters:

characterSubset - 유니코드 문자 하위 집합의 이름인 문자열 또는 null

Since:

MIDP 2.0