Package org.luwrain.controls

Class CommanderArea<E>

java.lang.Object

org.luwrain.controls.ListArea<CommanderArea.Wrapper<E>>

org.luwrain.controls.CommanderArea<E>

All Implemented Interfaces:

ClipboardTranslator.Provider, RegionTextQueryTranslator.Provider, Area, HotPoint, Lines

Direct Known Subclasses:

CommanderPopup

public class CommanderArea<E>
extends ListArea<CommanderArea.Wrapper<E>>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CommanderArea.Appearance<E>
static interface	CommanderArea.ClickHandler<E>
static enum	CommanderArea.EntryType
static interface	CommanderArea.Filter<E>
static enum	CommanderArea.Flags
static class	CommanderArea.ListAppearanceImpl<E>
protected static class	CommanderArea.ListModelAdapter<E>
static interface	CommanderArea.Model<E>
protected static interface	CommanderArea.NativeItem<E>
static class	CommanderArea.Params<E>
static class	CommanderArea.Wrapper<E>

Nested classes/interfaces inherited from class org.luwrain.controls.ListArea

ListArea.ClipboardSaver<E>, ListArea.ListeningInfo, ListArea.Transition

Field Summary

Fields

Modifier and Type	Field	Description
protected final CommanderArea.Appearance<E>	appearance
protected CommanderArea.ClickHandler<E>	clickHandler
protected boolean	closed
protected Comparator<CommanderArea.NativeItem<E>>	comparator
protected E	currentLocation
protected CommanderArea.Filter<E>	filter
protected final Set<CommanderArea.Flags>	flags
protected final CommanderArea.Model<E>	model
static final String	PARENT_DIR
protected FutureTask	task

Fields inherited from class org.luwrain.controls.ListArea

areaName, BRIEF_ANNOUNCEMENT_ONLY, clipboardTranslator, context, hotPointX, hotPointY, listAppearance, listClickHandler, listClipboardSaver, listFlags, listModel, listTransition, NONE_APPEARANCE_FLAGS, regionPoint, regionTextQueryTranslator

Constructor Summary

Constructors

Constructor	Description
CommanderArea(CommanderArea.Params<E> params)

Method Summary

Modifier and Type	Method	Description
protected void	acceptNewLocation(E location, List<CommanderArea.Wrapper<E>> data, int selectedIndex, boolean announce)
protected boolean	clickImpl(int index, CommanderArea.Wrapper<E> wrapper)
void	close()
protected static <E> ListArea.Params<CommanderArea.Wrapper<E>>	createListParams(CommanderArea.Params<E> params)
boolean	findFileName(String fileName, boolean announce)
String	getAreaName()
protected String	getBaseName(CommanderArea.Wrapper wrapper)
CommanderArea.Model<E>	getCommanderModel()
CommanderArea.ListModelAdapter<E>	getListModel()	Returns the data model used by this list.
Object[]	getMarked()
String[]	getMarkedNames()
protected CommanderArea.Wrapper<E>[]	getMarkedWrappers()
E	getSelectedEntry()
String	getSelectedEntryText()
protected CommanderArea.Wrapper<E>	getSelectedWrapper()
boolean	isBusy()
boolean	isEmpty()	Checks whether the list model contains any items.
protected String	noContentStr()	Returns the string to display when the list has no content.
protected boolean	onBackspace(InputEvent event)
boolean	onClipboardCopy(int fromX, int fromY, int toX, int toY, boolean withDeleting)
boolean	onInputEvent(InputEvent event)
protected boolean	onMarking(InputEvent event)
boolean	open(E entry)
boolean	open(E entry, boolean announce)
boolean	open(E entry, String desiredSelected)
boolean	open(E entry, String desiredSelected, boolean announce)
boolean	open(E entry, String desiredSelected, String[] desiredMarked, boolean announce)
E	opened()
boolean	reread(boolean announce)
boolean	reread(String desiredSelected, boolean announce)
void	setClickHandler(CommanderArea.ClickHandler<E> clickHandler)
void	setCommanderComparator(Comparator<CommanderArea.NativeItem<E>> comparator)
void	setCommanderFilter(CommanderArea.Filter<E> filter)
void	setListClickHandler(ListArea.ClickHandler clickHandler)	Sets the click handler for item activation.

Methods inherited from class org.luwrain.controls.ListArea

announceChar, announceSelected, getAreaActions, getExistingItemIndexOnLine, getHotPointX, getHotPointY, getItemIndexOnLine, getItemOnLine, getLine, getLineCount, getLineIndexByItemIndex, getListAppearance, getListItemCount, getObservableSubstr, noContent, onAltEnd, onAltHome, onAltLeft, onAltRight, onAnnounce, onAnnounceLine, onAreaQuery, onBeginListeningQuery, onChar, onClipboardCopyAll, onDeleteRegion, onEnd, onEnter, onHome, onListeningFinishedEvent, onMoveDown, onMoveHotPoint, onMoveLeft, onMoveRight, onMoveUp, onNewHotPointY, onOk, onPageDown, onPageUp, onRegionTextQuery, onSystemEvent, onTransition, redraw, refresh, reset, resetHotPoint, resetHotPoint, select, select, selected, selectedIndex, selectEmptyLineBottom, setAreaName

Methods inherited from class java.lang.Object

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

Field Details

PARENT_DIR

public static final String PARENT_DIR

See Also:

• Constant Field Values

model

protected final CommanderArea.Model<E> model

appearance

protected final CommanderArea.Appearance<E> appearance

flags

protected final Set<CommanderArea.Flags> flags

clickHandler

protected CommanderArea.ClickHandler<E> clickHandler

filter

protected CommanderArea.Filter<E> filter

comparator

protected Comparator<CommanderArea.NativeItem<E>> comparator

currentLocation

protected E currentLocation

task

protected FutureTask task

closed

protected boolean closed

Constructor Details

CommanderArea

public CommanderArea(CommanderArea.Params<E> params)

Method Details

getCommanderModel

public CommanderArea.Model<E> getCommanderModel()

setCommanderFilter

public void setCommanderFilter(CommanderArea.Filter<E> filter)

setCommanderComparator

public void setCommanderComparator(Comparator<CommanderArea.NativeItem<E>> comparator)

close

public void close()

findFileName

public boolean findFileName(String fileName,
 boolean announce)

isBusy

public boolean isBusy()

isEmpty

public boolean isEmpty()

Description copied from class: ListArea

Checks whether the list model contains any items.

Overrides:

isEmpty in class ListArea<CommanderArea.Wrapper<E>>

Returns:

true if the model is empty, false otherwise

getSelectedWrapper

protected CommanderArea.Wrapper<E> getSelectedWrapper()

getSelectedEntry

public E getSelectedEntry()

getSelectedEntryText

public String getSelectedEntryText()

opened

public E opened()

getMarked

public Object[] getMarked()

getMarkedNames

public String[] getMarkedNames()

getMarkedWrappers

protected CommanderArea.Wrapper<E>[] getMarkedWrappers()

open

public boolean open(E entry)

open

public boolean open(E entry,
 String desiredSelected)

open

public boolean open(E entry,
 boolean announce)

open

public boolean open(E entry,
 String desiredSelected,
 boolean announce)

open

public boolean open(E entry,
 String desiredSelected,
 String[] desiredMarked,
 boolean announce)

reread

public boolean reread(boolean announce)

reread

public boolean reread(String desiredSelected,
 boolean announce)

acceptNewLocation

protected void acceptNewLocation(E location,
 List<CommanderArea.Wrapper<E>> data,
 int selectedIndex,
 boolean announce)

getListModel

public CommanderArea.ListModelAdapter<E> getListModel()

Description copied from class: ListArea

Returns the data model used by this list.

Overrides:

getListModel in class ListArea<CommanderArea.Wrapper<E>>

Returns:

the model

setClickHandler

public void setClickHandler(CommanderArea.ClickHandler<E> clickHandler)

setListClickHandler

public void setListClickHandler(ListArea.ClickHandler clickHandler)

Description copied from class: ListArea

Sets the click handler for item activation.

Overrides:

setListClickHandler in class ListArea<CommanderArea.Wrapper<E>>

Parameters:

clickHandler - the handler to set (may be null)

onInputEvent

public boolean onInputEvent(InputEvent event)

Specified by:

onInputEvent in interface Area

Overrides:

onInputEvent in class ListArea<CommanderArea.Wrapper<E>>

getAreaName

public String getAreaName()

Specified by:

getAreaName in interface Area

Overrides:

getAreaName in class ListArea<CommanderArea.Wrapper<E>>

onClipboardCopy

public boolean onClipboardCopy(int fromX,
 int fromY,
 int toX,
 int toY,
 boolean withDeleting)

Specified by:

onClipboardCopy in interface ClipboardTranslator.Provider

Overrides:

onClipboardCopy in class ListArea<CommanderArea.Wrapper<E>>

onBackspace

protected boolean onBackspace(InputEvent event)

onMarking

protected boolean onMarking(InputEvent event)

clickImpl

protected boolean clickImpl(int index,
 CommanderArea.Wrapper<E> wrapper)

noContentStr

protected String noContentStr()

Description copied from class: ListArea

Returns the string to display when the list has no content.

Overrides:

noContentStr in class ListArea<CommanderArea.Wrapper<E>>

Returns:

the "no content" string

getBaseName

protected String getBaseName(CommanderArea.Wrapper wrapper)

createListParams

protected static <E>
ListArea.Params<CommanderArea.Wrapper<E>> createListParams(CommanderArea.Params<E> params)