@Override
public RegionContent getWholeRegion() {
if (model == null || model.getItemCount() < 0) return null;
final LinkedList<String> res = new LinkedList<String>();
final int count = model.getItemCount();
for (int i = 0; i < count; ++i) {
final String line = appearance.getScreenAppearance(model.getItem(i), NONE_APPEARANCE_FLAGS);
res.add(line != null ? line : "");
}
res.add("");
return new RegionContent(res.toArray(new String[res.size()]));
}
protected boolean onChar(KeyboardEvent event) {
if (noContent()) return true;
final int count = model.getItemCount();
final char c = event.getChar();
final String beginning;
if (selected() != null) {
if (hotPointX >= appearance.getObservableRightBound(selected())) return false;
final String name = getObservableSubstr(selected());
final int pos =
Math.min(hotPointX - appearance.getObservableLeftBound(selected()), name.length());
if (pos < 0) return false;
beginning = name.substring(0, pos);
} else beginning = "";
Log.debug("list", "beginning:" + beginning);
final String mustBegin = beginning + c;
for (int i = 0; i < count; ++i) {
Log.debug("list", "checking:" + i);
final String name = getObservableSubstr(model.getItem(i));
Log.debug("list", "name:" + name);
if (!name.startsWith(mustBegin)) continue;
hotPointY = getLineIndexByItemIndex(i);
Log.debug("list", "hotPointY:" + hotPointY);
++hotPointX;
appearance.announceItem(model.getItem(hotPointY), NONE_APPEARANCE_FLAGS);
environment.onAreaNewHotPoint(this);
return true;
}
return false;
}
protected boolean onBeginListeningQuery(BeginListeningQuery query) {
NullCheck.notNull(query, "query");
final int index = selectedIndex();
if (index < 0) return false;
final int count = model.getItemCount();
if (index >= count) return false;
final Object current = model.getItem(index);
final String text =
appearance
.getScreenAppearance(current, NONE_APPEARANCE_FLAGS)
.substring(hotPointX, appearance.getObservableRightBound(current));
// Log.debug("listen", appearance.getScreenAppearance(current, NONE_APPEARANCE_FLAGS));
// Log.debug("listen", "" + hotPointX);
if (text.isEmpty() && index + 1 >= count) return false;
if (index + 1 < count) {
final Object next = model.getItem(index + 1);
query.answer(
new BeginListeningQuery.Answer(
text, new ListeningInfo(index + 1, appearance.getObservableLeftBound(next))));
} else
query.answer(
new BeginListeningQuery.Answer(
text, new ListeningInfo(index, appearance.getObservableRightBound(current))));
return true;
}
protected boolean noContent() {
if (model == null || model.getItemCount() < 1) {
environment.hint(noContentStr(), Hints.NO_CONTENT);
return true;
}
return false;
}
@Override
public int getLineCount() {
final int emptyCountTop = flags.contains(Flags.EMPTY_LINE_TOP) ? 1 : 0;
final int emptyCountBottom = flags.contains(Flags.EMPTY_LINE_BOTTOM) ? 1 : 0;
final int res = model.getItemCount() + emptyCountTop + emptyCountBottom;
return res >= 1 ? res : 1;
}
@Override
public String getLine(int index) {
if (isEmpty()) return index == 0 ? noContentStr() : "";
final int itemIndex = getItemIndexOnLine(index);
if (itemIndex < 0 || itemIndex >= model.getItemCount()) return "";
final Object res = model.getItem(itemIndex);
return res != null ? appearance.getScreenAppearance(res, NONE_APPEARANCE_FLAGS) : "";
}
@Override
public RegionContent getRegion(int fromX, int fromY, int toX, int toY) {
if (model == null || model.getItemCount() < 0) return null;
if (fromY >= model.getItemCount() || toY > model.getItemCount()) return null;
if (fromY == toY) {
final String line =
appearance.getScreenAppearance(model.getItem(fromY), NONE_APPEARANCE_FLAGS);
if (line == null || line.isEmpty()) return null;
final int fromPos = fromX < line.length() ? fromX : line.length();
final int toPos = toX < line.length() ? toX : line.length();
if (fromPos >= toPos) return null;
return new RegionContent(new String[] {line.substring(fromPos, toPos)});
}
final LinkedList<String> res = new LinkedList<String>();
for (int i = fromY; i < toY; ++i) {
final String line = appearance.getScreenAppearance(model.getItem(i), NONE_APPEARANCE_FLAGS);
res.add(line != null ? line : "");
}
res.add("");
return new RegionContent(res.toArray(new String[res.size()]));
}
/**
* Searches for the item in the model and sets hot point on it. Given an arbitrary object, this
* method looks through all items in the model and does a couple of checks: literal pointers
* equality and a check with {@code equals()} method. If at least one of these checks succeeds,
* the item is considered equal to the given one, and hot points is set on it.
*
* @param obj The object to search for
* @param introduce Must be true if it is necessary to introduce the object, once it's found
* @return True if the request object is found, false otherwise
*/
public boolean select(Object obj, boolean introduce) {
NullCheck.notNull(obj, "obj");
for (int i = 0; i < model.getItemCount(); ++i) {
final Object o = model.getItem(i);
if (o == null || (obj != o && !obj.equals(o))) continue;
hotPointY = i;
hotPointX = appearance.getObservableLeftBound(o);
environment.onAreaNewHotPoint(this);
if (introduce) appearance.announceItem(o, NONE_APPEARANCE_FLAGS);
return true;
}
return false;
}
/**
* Selects the item by its index. Given the non-negative integer value as an index, this method
* sets the hot point on the item addressed with this index, checking only that index is in
* appropriate bounds. Index must address the object as a number in the model, ignoring any empty
* lines.
*
* @param index The item index to select
* @param announce Must be true, if it is necessary to announce the item , once it has been
* selected
* @return True if the index is valid and the item gets hot point on it
*/
public boolean select(int index, boolean announce) {
if (index < 0 || index >= model.getItemCount()) return false;
final int emptyCountAbove = flags.contains(Flags.EMPTY_LINE_TOP) ? 1 : 0;
hotPointY = index + emptyCountAbove;
final Object item = model.getItem(index);
if (item != null) {
hotPointX = appearance.getObservableLeftBound(item);
if (announce) appearance.announceItem(item, NONE_APPEARANCE_FLAGS);
} else {
hotPointX = 0;
if (announce) environment.hint(Hints.EMPTY_LINE);
}
environment.onAreaNewHotPoint(this);
return true;
}
protected boolean onListeningFinishedEvent(ListeningFinishedEvent event) {
NullCheck.notNull(event, "event");
if (!(event.getExtraInfo() instanceof ListeningInfo)) return false;
final ListeningInfo info = (ListeningInfo) event.getExtraInfo();
final int count = model.getItemCount();
if (info.itemIndex >= count) return false;
final Object item = model.getItem(info.itemIndex);
final int leftBound = appearance.getObservableLeftBound(item);
final int rightBound = appearance.getObservableRightBound(item);
if (info.pos < leftBound || info.pos > rightBound) return false;
hotPointY = getLineIndexByItemIndex(info.itemIndex);
hotPointX = info.pos;
environment.onAreaNewHotPoint(this);
return true;
}
/**
* Refreshes the content of the list. This method calls {@code refresh()} method of the model and
* displays new items. It does not produce any speech announcement of the change. HotPointY is
* preserved if it is possible (meaning, the new number of lines not less than old value of
* hotPointY), but hotPointX is moved to the beginning of the line.
*/
public void refresh() {
model.refresh();
final int count = model.getItemCount();
if (count == 0) {
hotPointX = 0;
hotPointY = 0;
environment.onAreaNewContent(this);
environment.onAreaNewHotPoint(this);
return;
}
hotPointY = hotPointY < count ? hotPointY : count - 1;
final Object item = model.getItem(hotPointY);
if (item != null) hotPointX = appearance.getObservableLeftBound(item);
else hotPointX = 0;
environment.onAreaNewContent(this);
environment.onAreaNewHotPoint(this);
}
protected boolean onTransition(Transition.Type type, int hint, boolean briefAnnouncement) {
NullCheck.notNull(type, "type");
// NullCheck.notNull(hint, "hint");
if (noContent()) return true;
final int index = selectedIndex();
final int count = model.getItemCount();
final int emptyCountTop = flags.contains(Flags.EMPTY_LINE_TOP) ? 1 : 0;
final Transition.State current;
if (index >= 0) current = new Transition.State(index);
else if (flags.contains(Flags.EMPTY_LINE_TOP) && hotPointY == 0)
current = new Transition.State(Transition.State.Type.EMPTY_LINE_TOP);
else if (flags.contains(Flags.EMPTY_LINE_BOTTOM) && hotPointY == count + emptyCountTop)
current = new Transition.State(Transition.State.Type.EMPTY_LINE_BOTTOM);
else return false;
final Transition.State newState =
transition.transition(
type,
current,
count,
flags.contains(Flags.EMPTY_LINE_TOP),
flags.contains(Flags.EMPTY_LINE_BOTTOM));
NullCheck.notNull(newState, "newState");
Log.debug("list", "newState=" + newState.type);
switch (newState.type) {
case NO_TRANSITION:
environment.hint(hint);
return true;
case EMPTY_LINE_TOP:
if (!flags.contains(Flags.EMPTY_LINE_TOP)) return false;
hotPointY = 0;
break;
case EMPTY_LINE_BOTTOM:
if (!flags.contains(Flags.EMPTY_LINE_BOTTOM)) return false;
hotPointY = count + emptyCountTop;
break;
case ITEM_INDEX:
if (newState.itemIndex < 0 || newState.itemIndex >= count) return false;
hotPointY = newState.itemIndex + emptyCountTop;
break;
default:
return false;
}
onNewHotPointY(briefAnnouncement);
return true;
}
public void resetHotPoint(boolean introduce) {
hotPointY = 0;
final int count = model.getItemCount();
if (count < 1) {
hotPointX = 0;
environment.onAreaNewHotPoint(this);
return;
}
final Object item = model.getItem(0);
if (item != null) {
hotPointX = item != null ? appearance.getObservableLeftBound(item) : 0;
if (introduce) appearance.announceItem(item, NONE_APPEARANCE_FLAGS);
} else {
hotPointX = 0;
environment.hint(Hints.EMPTY_LINE);
}
environment.onAreaNewHotPoint(this);
}
/**
* Returns the object in the model corresponding to current hot point position. If the model is
* empty or hot point is on an empty line, this method always returns {@code null}.
*
* @return The object in the model associated with the currently selected line or {@code null} if
* there is no any
*/
public final Object selected() {
final int index = selectedIndex();
return (index >= 0 && index < model.getItemCount()) ? model.getItem(index) : null;
}
public int getItemIndexOnLine(int index) {
final int linesTop = flags.contains(Flags.EMPTY_LINE_TOP) ? 1 : 0;
if (index < linesTop) return -1;
if (index - linesTop < model.getItemCount()) return index - linesTop;
return -1;
}
public int getLineIndexByItemIndex(int index) {
final int count = model.getItemCount();
if (index < 0 || index >= count) return -1;
final int linesTop = flags.contains(Flags.EMPTY_LINE_TOP) ? 1 : 0;
return index + linesTop;
}
public boolean isEmpty() {
return model.getItemCount() <= 0;
}