/*
* Copyright (C) 2008 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.view.inputmethod;
import android.os.Parcel;
import android.os.Parcelable;
import android.text.TextUtils;
Information about text that has been extracted for use by an input method.
This contains information about a portion of the currently edited text,
that the IME should display into its own interface while in extracted mode.
/**
* Information about text that has been extracted for use by an input method.
*
* This contains information about a portion of the currently edited text,
* that the IME should display into its own interface while in extracted mode.
*/
public class ExtractedText implements Parcelable {
The text that has been extracted.
See Also: - getText.getText()
/**
* The text that has been extracted.
*
* @see android.widget.TextView#getText()
*/
public CharSequence text;
The offset in the overall text at which the extracted text starts.
/**
* The offset in the overall text at which the extracted text starts.
*/
public int startOffset;
If the content is a report of a partial text change, this is the offset where the change starts and it runs until partialEndOffset. If the content is the full text, this field is -1. /**
* If the content is a report of a partial text change, this is the
* offset where the change starts and it runs until
* {@link #partialEndOffset}. If the content is the full text, this
* field is -1.
*/
public int partialStartOffset;
If the content is a report of a partial text change, this is the offset where the change ends. Note that the actual text may be larger or smaller than the difference between this and partialStartOffset, meaning a reduction or increase, respectively, in the total text. /**
* If the content is a report of a partial text change, this is the offset
* where the change ends. Note that the actual text may be larger or
* smaller than the difference between this and {@link #partialStartOffset},
* meaning a reduction or increase, respectively, in the total text.
*/
public int partialEndOffset;
The offset where the selection currently starts within the extracted
text. The real selection start position is at
startOffset+selectionStart.
/**
* The offset where the selection currently starts within the extracted
* text. The real selection start position is at
* <var>startOffset</var>+<var>selectionStart</var>.
*/
public int selectionStart;
The offset where the selection currently ends within the extracted
text. The real selection end position is at
startOffset+selectionEnd.
/**
* The offset where the selection currently ends within the extracted
* text. The real selection end position is at
* <var>startOffset</var>+<var>selectionEnd</var>.
*/
public int selectionEnd;
Bit for flags: set if the text being edited can only be on a single line. /**
* Bit for {@link #flags}: set if the text being edited can only be on
* a single line.
*/
public static final int FLAG_SINGLE_LINE = 0x0001;
Bit for flags: set if the editor is currently in selection mode. This happens when a hardware keyboard with latched keys is attached and the shift key is currently latched. /**
* Bit for {@link #flags}: set if the editor is currently in selection mode.
*
* This happens when a hardware keyboard with latched keys is attached and
* the shift key is currently latched.
*/
public static final int FLAG_SELECTING = 0x0002;
Additional bit flags of information about the edited text.
/**
* Additional bit flags of information about the edited text.
*/
public int flags;
The hint that has been extracted.
See Also: - getHint.getHint()
/**
* The hint that has been extracted.
*
* @see android.widget.TextView#getHint()
*/
public CharSequence hint;
Used to package this object into a Parcel. Params: - dest – The
Parcel to be written. - flags – The flags used for parceling.
/**
* Used to package this object into a {@link Parcel}.
*
* @param dest The {@link Parcel} to be written.
* @param flags The flags used for parceling.
*/
public void writeToParcel(Parcel dest, int flags) {
TextUtils.writeToParcel(text, dest, flags);
dest.writeInt(startOffset);
dest.writeInt(partialStartOffset);
dest.writeInt(partialEndOffset);
dest.writeInt(selectionStart);
dest.writeInt(selectionEnd);
dest.writeInt(this.flags);
TextUtils.writeToParcel(hint, dest, flags);
}
Used to make this class parcelable.
/**
* Used to make this class parcelable.
*/
public static final Parcelable.Creator<ExtractedText> CREATOR
= new Parcelable.Creator<ExtractedText>() {
public ExtractedText createFromParcel(Parcel source) {
ExtractedText res = new ExtractedText();
res.text = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(source);
res.startOffset = source.readInt();
res.partialStartOffset = source.readInt();
res.partialEndOffset = source.readInt();
res.selectionStart = source.readInt();
res.selectionEnd = source.readInt();
res.flags = source.readInt();
res.hint = TextUtils.CHAR_SEQUENCE_CREATOR.createFromParcel(source);
return res;
}
public ExtractedText[] newArray(int size) {
return new ExtractedText[size];
}
};
public int describeContents() {
return 0;
}
}