abstractcomposer.java

J2me应用开发经典例子

package com.jmobilecore.ui.core;

/**
 * The <code>AbstractComposer</code> interface defines set of methods
 * that supports a text caret's handling and basic text editing.
 *
 * @author Greg Gridin
 */
public interface AbstractComposer {

    /**
     * Moves the caret one position left
     *
     * @return <code>true</code> if the moving is possible/done, <code>false</code> otherwise
     */
    public boolean caretLeft();

    /**
     * Moves the caret one position right
     *
     * @return <code>true</code> if the moving is possible/done, <code>false</code> otherwise
     */
    public boolean caretRight();

    /**
     * Deletes previous symbol, moves cursor one position left
     *
     * @return <code>true</code> if the delete and moving is possible/done, <code>false</code> otherwise
     */
    public boolean backspace();


    public boolean addChar(char ch, boolean insertMode);

    /**
     * Deletes current symbol
     *
     * @return <code>true</code> if the delete possible/done, <code>false</code> otherwise
     */
    public boolean deleteChar();

    /**
     * Returns the char array (mutable) that is presented by this text component.
     * Usually works faster and more efficient than #getText
     */
    public char[] getChars();

    /**
     * Returns the immutable string that is presented by this text component.
     */
    public String getText();

    /**
     * Returns the current text length
     */
    public int getCurrentLength();

    /**
     * Sets the text that is presented by this
     * text component to be the specified text.
     *
     * @param newText the new text.
     */
    public void setText(String newText);

    /**
     * Returns the caret position
     */
    public int getCaretPosition();

    /**
     * Sets the caret position
     * @param caretPosition new caret position
     * @return <code>true</code> if operation is successful, <code>false</code> otherwise
     */
    public boolean setCaretPosition(int caretPosition);

    /**
     * Default destructor. Helps VM to perform garbage collection
     */
    public void destructor();
}