Class ListArea<E>

    • Method Detail

      • selected

        public final E selected()
        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 null.
        Returns:
        The object in the model associated with the currently selected line or null if there is no any
      • selectedIndex

        public final int selectedIndex()
        The index of the item in the model which is under the hot point in this list. This method returns the index in the model, not on the screen. It means that the value returned by this method may be different than the value returned by getHotPointY() (but may be equal as well). If the list is empty or an empty line is selected, this method returns -1.
        Returns:
        The index of the selected line in the model or -1 if there is no any
      • select

        public boolean select​(Object obj,
                              boolean announce)
        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 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.
        Parameters:
        obj - The object to search for
        announce - Must be true if it is necessary to introduce the object, once it's found
        Returns:
        True if the request object is found, false otherwise
      • select

        public boolean select​(int index,
                              boolean announce)
        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.
        Parameters:
        index - The item index to select
        announce - Must be true, if it is necessary to announce the item , once it has been selected
        Returns:
        True if the index is valid and the item gets hot point on it
      • selectEmptyLineBottom

        public boolean selectEmptyLineBottom​(boolean announce)
      • getExistingItemIndexOnLine

        public int getExistingItemIndexOnLine​(int lineIndex)
      • getItemIndexOnLine

        public int getItemIndexOnLine​(int index)
      • getLineIndexByItemIndex

        public int getLineIndexByItemIndex​(int index)
      • getItemOnLine

        public E getItemOnLine​(int lineIndex)
      • getListItemCount

        public int getListItemCount()
      • reset

        public void reset​(boolean announce)
      • resetHotPoint

        public void resetHotPoint()
      • resetHotPoint

        public void resetHotPoint​(boolean introduce)
      • announceSelected

        public void announceSelected()
      • refresh

        public void refresh()
        Refreshes the content of the list. This method calls 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.
      • redraw

        public void redraw()
      • isEmpty

        public boolean isEmpty()
      • getLineCount

        public int getLineCount()
        Specified by:
        getLineCount in interface Lines
      • getLine

        public String getLine​(int index)
        Specified by:
        getLine in interface Lines
      • setAreaName

        public void setAreaName​(String areaName)
      • onAnnounce

        protected boolean onAnnounce()
        Announces the list area. If the area is created with AREA_ANNOUNCE_SELECTED flag, this method speaks the screen text of the currently selected item or the area name otherwise (without the flag or if there is no selected item).
      • onAnnounceLine

        protected boolean onAnnounceLine()
      • onBeginListeningQuery

        protected boolean onBeginListeningQuery​(BeginListeningQuery query)
      • onChar

        protected boolean onChar​(InputEvent event)
      • onMoveDown

        protected boolean onMoveDown​(InputEvent event,
                                     boolean briefAnnouncement)
      • onMoveUp

        protected boolean onMoveUp​(InputEvent event,
                                   boolean briefAnnouncement)
      • onPageDown

        protected boolean onPageDown​(InputEvent event,
                                     boolean briefAnnouncement)
      • onPageUp

        protected boolean onPageUp​(InputEvent event,
                                   boolean briefAnnouncement)
      • onEnd

        protected boolean onEnd​(InputEvent event)
      • onHome

        protected boolean onHome​(InputEvent event)
      • onMoveRight

        protected boolean onMoveRight​(InputEvent event)
      • onMoveLeft

        protected boolean onMoveLeft​(InputEvent event)
      • onAltRight

        protected boolean onAltRight​(InputEvent event)
      • onAltLeft

        protected boolean onAltLeft​(InputEvent event)
      • onAltEnd

        protected boolean onAltEnd​(InputEvent event)
      • onAltHome

        protected boolean onAltHome​(InputEvent event)
      • onEnter

        protected boolean onEnter​(InputEvent event)
      • onNewHotPointY

        protected void onNewHotPointY​(boolean briefAnnouncement)
      • getObservableSubstr

        protected String getObservableSubstr​(E item)
      • noContentStr

        protected String noContentStr()
      • announceChar

        protected void announceChar​(String line,
                                    int pos,
                                    int rightBound)
      • noContent

        protected boolean noContent()