eve.ui.data

Class ListEditor

java.lang.Object

eve.ui.ControlBase

eve.ui.Control

eve.ui.Container

eve.ui.Canvas

eve.ui.Panel

eve.ui.CellPanel

eve.ui.FormBase

eve.ui.Form

eve.ui.data.Editor

eve.ui.data.ListEditor

All Implemented Interfaces:

HasProperties, IOwnable, Drawable, ImageRefresher, DataInterface, TimerProc, CellConstants, ControlConstants, FieldListener, HasAncestor, IScroll, LayoutManager, ScrollClient, UIConstants, EventListener

Direct Known Subclasses:

IconListEdit

public class ListEditor
extends Editor

A ListEditor is used to edit a list (contained in a Vector) of Objects - usually LiveData objects.

The ListEditor can work in different ways:

• The list can be displayed alone and when an item is selected for editing, or when a new item is created, then an Editor is displayed for editing the item. This method is useful for small screen devices.
• The list can be displayed along with (above, below, left of or right of) an Editor that displays the contents of the selected item and allows the item to be immediately edited. This is useful for desktop systems.

There are buttons that can be displayed which allow for the following functions:

• Add a new item.
• Move a new item, to top, bottom, up one, down one.
• Delete an item
• Edit the contents of the default item (i.e. set the initial contents of a new item)

These buttons can be placed at the side of, or below the list.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListEditor.IListEditHandler This is an interface that can optionally be implemented by the Object class being edited.

Nested classes/interfaces inherited from class eve.ui.Form

Form.FormMaker, Form.ToolsOrSoftKey, Form.ValidateBeforeExit

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_BUTTONS
static int	ALL_BUTTONS_EXCEPT_TOOLS
static IImage	bottomIcon
boolean	confirmDelete
MenuItem	contextMenuItem
Editor	defaultEditor
static int	DELETE_BUTTON
static String	deleteItemFieldName
MenuItem	deleteMenu
Editor	display
static IImage	downIcon
static int	EDIT_BUTTON
static IImage	editIcon
Editor	editor
boolean	editorOnTop
String	itemName This is the name of the item being edited.
Vector	items These are the items being edited.
List	list This is the list of items.
int	listColumns
int	listRows
String	listTitle
Object	model
static int	NEW_BUTTON
boolean	newDoesNotCopyFromModel
static String	newItemFieldName
MenuItem	newMenu
static int	OPTION_DO_HSPLIT
static int	OPTION_DO_VSPLIT
static int	OPTION_DONT_SETUP This option when used with a constructor tells the ListEditor not to do the setup.
static int	OPTION_EDITOR_AFTER_LIST
static int	OPTION_EDITOR_BEFORE_LIST
static int	OPTION_NO_LIST_MANIPULATION
static int	OPTION_NO_SPLITTABLE_PANEL
static int	OPTION_TOOL_BUTTONS_IN_SCROLL_BAR
static int	TOOL_BUTTON
MenuItem	toolMenuItem
Menu	toolsMenu
static int	TOPBOTTOM_BUTTONS
static IImage	topIcon
protected CellPanel	underList
static int	UPDOWN_BUTTONS
static IImage	upIcon
boolean	useSplittablePanel
boolean	vSplit If a splittable panel is used, this says if the two sections are vertically laid out.

Fields inherited from class eve.ui.data.Editor

autoRefreshControls, coroutineStackSize, currentEvent, DoDataTransfer, dontAddSoftkeysAsActions, fieldListeners, fieldsWillNotBeAdded, myObject, objectClass, sampleObject, transferOnAdding, transfers

Fields inherited from class eve.ui.Form

acceptsDroppedFiles, apply, back, buttons, BUTTONS_TO_SOFT_KEY_FIRST_BUTTON_SEPARATE, BUTTONS_TO_SOFT_KEY_MENU_ALWAYS, BUTTONS_TO_SOFT_KEY_USE_FIRST_SOFT_KEY, buttonsPanel, buttonsPerRow, cancel, CLOSING_FLAG, deflt, dismantleOnClose, dontAddSIPFiller, exitButtonDefined, EXITING_FLAG, exitSystemOnClose, exitValue, firstFocus, formFrame, frameAlpha, handle, hasTitle, hasTopBar, hideSoftKeyBarIfNotFound, inheritSoftKeys, isAutoScrolling, isMainAppletForm, keepFrame, minimumShowTime, moveable, no, noBorder, ok, pl, reset, resizable, resizeOnSIP, shadowed, SHOWN_FLAG, shownTime, softkeyBars, title, titleCancel, titleControls, titleOK, topControls, WINDOW_TITLE_DONT_CHANGE, windowFlagsToClear, windowFlagsToSet, windowIcon, windowTitle, yes

Fields inherited from class eve.ui.FormBase

BACKB, CANCELB, checkIcon, close, cross, crossIcon, DEFCANCELB, DEFOKB, EXIT_IDBACK, EXIT_IDCANCEL, EXIT_IDNO, EXIT_IDOK, EXIT_IDYES, IDBACK, IDCANCEL, IDNO, IDOK, IDYES, MBB, MBNONE, MBOK, MBOKCANCEL, MBYESNO, MBYESNOCANCEL, NOB, OKB, stop, tick, tools, YESB

Fields inherited from class eve.ui.CellPanel

autoSpan, layout, mySplitter, nextSplitter, quickRecalculate

Fields inherited from class eve.ui.Panel

all, calculated, childListeners, defaultAddToMeCellConstraints, defaultTags, equalHeights, equalWidths, grid, lastAdded, layoutManager, made, noInsets, stretchFirstColumn, stretchFirstRow, stretchLastColumn, stretchLastRow, titleGap

Fields inherited from class eve.ui.Canvas

isFullScrollClient, origin, scrollPercent, virtualSize

Fields inherited from class eve.ui.Container

closedFocus, cycleFocus, dontAutoScroll, dontFocusOnChildren, FIND_FOR_MOUSE_PRESS, takeNextFocus

Fields inherited from class eve.ui.Control

backGround, beforeRemoved, borderColor, borderStyle, borderWidth, children, columns, constraints, curFont, debugModify, debugRepaintNow, disabledBackground, dragging, dragResolution, dragTime, exitKeys, fieldTransfer, font, fontChange, fontFrom, foreGround, height, holdDownPause, holdTick, hotKey, image, lastSelected, listeners, lockPaint, maxHeight, maxWidth, menuState, minHeight, minWidth, modifiers, name, next, parent, penStatus, preferredHeight, preferredWidth, prev, prompt, promptControl, rows, ss, startDragResolution, tags, tail, text, toolTip, width, x, y

Fields inherited from class eve.ui.ControlBase

clipItems, clipObject, clipOwner, debugControl, debugFlag, doubleBuffer, doubleClickTime, doubleSizedFontHeight, firstPress, globalEditable, globalEnabled, PEN_STATUS_DID_HOLD_DOWN, PEN_STATUS_GOT_PEN_DOWN, PEN_STATUS_PEN_IS_ON, pressPoint, TAG_BOOLEAN_KEEP_BELOW_SIP, TAG_HOVER_TIME_INT, TAG_LAST_USER_DATA, TAG_USER_DATA, TAKE_FIRST_PRESS, unnamed

Fields inherited from interface eve.ui.CellConstants

ALWAYS_STRETCHABLE, BOTTOM, CELLFLAG, CELLMASK, CENTER, CONTROLMASK, DONTCHANGE, DONTFILL, DONTSTRETCH, EAST, FILL, GROW, HCENTER, HCONTRACT, HEXPAND, HFILL, HGROW, HSHRINK, HSTRETCH, INITIALLY_CLOSED, INITIALLY_HIDDEN, INITIALLY_MINIMIZED, INITIALLY_PREFERRED_SIZE, INSETS, LEFT, MAXIMUMSIZE, MINIMUMSIZE, NORTH, NORTHEAST, NORTHWEST, PREFERREDSIZE, RECT, RIGHT, SHRINK, SOUTH, SOUTHEAST, SOUTHWEST, SPAN, STRETCH, TAG_BACKGROUND_IMAGE, TAG_BUSY_DISPLAY, TAG_COLORS, TAG_CONTROL_PAINTER, TAG_EXPOSE_GROUP, TAG_FIXEDSIZE, TAG_GRAY_BACKGROUND, TAG_HIDE_CONTROL_OBJECT, TAG_HIDE_PARENT, TAG_INNER_TEXT_INSETS, TAG_INPUT_STACK_PARENT, TAG_INSETS, TAG_MAKE_VISIBLE, TAG_MAXIMUMSIZE, TAG_MINIMUMSIZE, TAG_PAINT_CONTROL_LIST, TAG_PREFERRED_TEXT_SIZE, TAG_PREFERRED_TEXT_SIZE_HEIGHT, TAG_PREFERRED_TEXT_SIZE_WIDTH, TAG_PREFERREDSIZE, TAG_RECT, TAG_SHADOW_INSETS, TAG_SPAN, TAG_SWIPER, TAG_TEMPORARY_ERROR, TAG_TEXT_INSETS, TAG_TEXTSIZE, TEXTSIZE, TOP, VCENTER, VCONTRACT, VEXPAND, VFILL, VGROW, VSHRINK, VSTRETCH, WEST

Fields inherited from interface eve.ui.IScroll

GoHigher, GoLower, Horizontal, OPTION_INDICATOR_ONLY, PageHigher, PageLower, ScrollHigher, ScrollLower, TrackTo, Vertical

Fields inherited from interface eve.ui.UIConstants

BDR_DOTTED, BDR_INNER, BDR_NOBORDER, BDR_OUTER, BDR_OUTLINE, BDR_RAISEDINNER, BDR_RAISEDOUTER, BDR_SUNKENINNER, BDR_SUNKENOUTER, BF_ABUT_ANY, BF_ABUT_BOTTOM, BF_ABUT_LEFT, BF_ABUT_RIGHT, BF_ABUT_TOP, BF_BOTTOM, BF_BOTTOMLEFT, BF_BOTTOMRIGHT, BF_BUTTON, BF_DIAGONAL, BF_DIAGONAL_ENDBOTTOMLEFT, BF_DIAGONAL_ENDBOTTOMRIGHT, BF_DIAGONAL_ENDTOPLEFT, BF_DIAGONAL_ENDTOPRIGHT, BF_EXACT, BF_FLAT, BF_LEFT, BF_MIDDLE, BF_MONO, BF_PALM, BF_RECT, BF_RIGHT, BF_SOFT, BF_SQUARE, BF_TOP, BF_TOPLEFT, BF_TOPRIGHT, EDGE_BUMP, EDGE_ETCHED, EDGE_RAISED, EDGE_SUNKEN

Fields inherited from interface eve.ui.ControlConstants

All, AlwaysEnabled, AlwaysRecalculateSizes, ByDeferredMouse, ByDeferredPen, ByFrameChange, ByKeyboard, ByMouse, ByPen, ByRequest, CalculatedSizes, ContainerDontPaintChildren, Disabled, DisablePopupMenu, DisplayOnly, DontBuffer, Down, DrawFlat, Flag, ForceResize, HasData, Invisible, KeepImage, KeepSIP, Left, MakeMenuAtLeastAsWide, Maximize, Minimize, ModifiersInheritedFromWindow, MouseSensitive, NoFocus, NotAnEditor, NotEditable, PaintDataOnly, PaintOutsideOnly, PenTransparent, PreferredSizeOnly, Right, SendUpUIEvents, ShowSIP, ShrinkToNothing, SmallControl, TakeChildUIEvents, TakeControlEvents, TakesKeyFocus, Transparent, Up, WantDrag, WantHoldDown

Fields inherited from interface eve.fx.ImageRefresher

KEEP_VISIBLE

Fields inherited from interface eve.fx.Drawable

ACTIVE, DISABLED, INACTIVE, INDENT_ITEM_FLAG, OUTLINED

Constructor Summary

Constructors

Constructor and Description
ListEditor() This constructor does no setup whatsoever - you will have to call setup() yourself.
ListEditor(LiveData forWhat, int display, int editor, int defaultEditor, boolean vertical, int buttonsAndOptions)
ListEditor(Object forWhat, boolean vertical, int buttonsAndOptions)

Method Summary

Modifier and Type	Method and Description
void	action(FieldTransfer ft, Editor ed) This implements the action() method in FieldListener.
void	action(String name, Editor ed) This gets called by action(FieldTransfer ft,Editor ed) and by fieldChanged(FieldTransfer ft,Editor ed) if the field changed is a menu item.
protected Button	addButton(CellPanel addTo, boolean vertical, IImage mi, String title, String field)
protected Button	addButton(CellPanel addTo, boolean vertical, String image, String title, String field)
protected boolean	displayInListChanged(MenuItem was, Object changed) This is called if the Editor indicates that the Object currently being has changed in some way.
void	doAddNew(Object toAdd) This adds a new item as if the user had pressed the New Item button.
void	doAddNew(Object toAdd, int index, boolean doNotify) This adds a new item or items (an array of Objects can be provided) as if the user had pressed the New Item button.
void	doDelete(int idx, boolean doNotify)
void	doEdit(int idx)
void	doStandardSetup(boolean verticalToolBar, int buttonsAndOptions, Editor toDisplay, Editor toEdit, Editor defaultEditor)
protected void	editingObjectChanged(Object editing) Called when the selected item has changed.
protected boolean	execEditor(Object toEdit, Editor editor)
void	fieldChanged(FieldTransfer ft, Editor ed) This implements the fieldChanged() method in FieldListener.
void	fieldEvent(FieldTransfer ft, Editor ed, Object event) This implements fieldEvent() in FieldListener.
void	getData(Object obj) Get the list of items.
Editor	getDataEditor()
Editor	getEditor(Object ld, int editor)
static IImage	getIcon(String image)
Object	getItem(int index) Get the item at the specified index.
int	getItemCount() Get the number of items.
Object	getListOwner(Class ownerClass)
String	getNameFor(Object item) Get the name for the item.
Object	getNewObject() Create and return a new default Object.
Control	getToolBar(boolean vertical, int buttons)
Control	getToolBar(boolean vertical, int buttons, boolean allowReconfigurable)
Object	getToPutInList(Object item)
static MenuItem	getUseNewItem(FontMetrics fm, String itemName)
void	itemsChanged(boolean doNotify, int select)
void	make(boolean reMake) This is used to "make" the control before being displayed.
void	nameChanged(int idx) This should be called if an item has its display name changed.
protected void	newSelected(int idx)
void	setData(Object what) Set the list of items.
void	setListTitle(String listTitle)
void	setup(LiveData forWhat, int display, int editor, int defaultEditor, boolean vertical, int buttonsAndOptions) Call this after using the constructor with the same parameters ONLY if OPTION_DONT_SETUP was included in buttonsAndOptions when the constructor was called.
void	setup(Object forWhat, boolean vertical, int buttonsAndOptions) Call this after using the constructor with the same parameters ONLY if OPTION_DONT_SETUP was included in buttonsAndOptions when the constructor was called.
protected void	shift(int idx, int dx)
void	shown() This is called when a Control is shown in a Window.
protected void	titleList(String listTitle)

Methods inherited from class eve.ui.data.Editor

addButtonAsAction, addExternalField, addExternalField, addField, addField, addField, addField, addMenuAsAction, addMenuItemAsAction, addSoftKeysAsActions, badField, canExit, changeField, convertData, dataChanged, dataChanged, dataObjectIsCompatible, dismantle, enableScrolling, fieldChanged, findControlFor, findControlFor, findFields, findFieldTransfer, findFieldTransfer, findFieldTransfer, fireAction, fireFieldChanged, fireFieldEvent, fireFieldEvent, focusOn, formClosing, fromControls, fromControls, fromControls, fromControls, getDataControls, getDataParentObject, getEditedObject, getEditedUnder, getEditorAndFieldValue, getFieldValue, getFieldValue, getProperty, getProperty, handleException, handleTransferError, invokeFieldHandlerMethod, main, modifyControl, modifyFields, modifyPropertiesOrFields, onControlEvent, onDataChangeEvent, onSoftKey, pauseCurrentEventThread, pauseThisEventThread, postEditorEvent, postEditorEvent, removeField, resumeCurrentEventThread, resumeThisEventThread, setDataControls, setEditedObject, setFields, setFields, setObject, setProperty, takeFieldFrom, toControls, toControls, toControls, toControls, transfer, transfer

Methods inherited from class eve.ui.Form

_getSetField, addButton, addFieldHandler, addFormMaker, addSIPAdjustment, addTabbedPanel, addToolbar, addTools, addToolsFor, addValidateBeforeExit, addValidateBeforeExit, buttonsToMenu, buttonsToSoftKeyBar, buttonsToSoftKeyBar, cancelWait, checkButtons, checkCanExit, close, closeAll, closeForTransfer, closeForTransfer, continueWait, createMenuItem, createMenuItem, createMenuItem, createSipFiller, createWindow, defaultTitleTo, doButtons, doShowExec, enableScrolling, exec, exec, exec, exec, exec, execute, execute, execute, exit, filesDropped, fixWindowTitle, formMain, fromFields, fromFields, fullScreenOnPDA, gatherButtons, getAncestorProperty, getButton, getFileSaver, getFormFrame, getFormWithProperty, getProperties, getSoftKeyBarFor, getTopmostForm, handleAction, handleAction, hasExitButton, makeButtonForForm, makeButtonForForm, makeDefaultButton, makeDefaultButton, makeFrame, makeMenuItemForForm, makeMenuItemForForm, makeSmall, makeSmallOnBigScreen, makeSoftKeys, makeSoftKeys, makeSoftKeys, maximizeOnPDA, menuItemSelected, modifyForSmartPhone, onEvent, onSoftKey, placeCancelOnLeft, removeSoftKeyBarFor, setAsMainAppletForm, setAsShown, setBelowButtonBar, setBelowButtonBars, setDefaultSize, setExitHandle, setFileSaver, setMainScrollBarPanel, setNoTitleBar, setSoftKeyBarFor, setSoftKeyBarForAll, setupFrame, show, show, showButtons, showExecCalled, showWait, showWait, startRunning, stopFormHandle, takeButtons, takeButtons, takeButtons, toFields, toFields, toolsOnBottom, validateBeforeExit, waitUntilClosed, waitUntilClosed, waitUntilClosed, waitUntilShown, willBeMaximized

Methods inherited from class eve.ui.FormBase

getCross, getParentObject, getParentObject, getSizedImage, getTick, getToolsIcon, setParentObject

Methods inherited from class eve.ui.CellPanel

calculateSizes, getFloatingControls, getSubControls, hasFloatingControls, makeLayoutGrid, relayoutMe, removeAll, reShow, resize, resizeTo

Methods inherited from class eve.ui.Panel

add, addChildListener, addDirectly, addLast, addLast, addLast, addNext, addNext, addNext, addNext, calculatedSizes, doBorder, endRow, getControlTag, getPreferredSize, insertRow, isEmpty, layout, remove, removeChildListener, sendToChildListeners, setAsBelowSip, setText

Methods inherited from class eve.ui.Canvas

canGo, canScreenScroll, checkScrolls, doScroll, fixOrigin, getActual, getBuffer, getCurrent, getDisplayedSize, getMyHeight, getMySize, getMyWidth, getPercent, getScrollablePanel, getScrollClient, getVisible, getVisibleArea, needScrollBar, onScroll, onSetOrigin, reduceClip, scroll, scroll, scrollToVisible, setOrigin, updateScrollServer

Methods inherited from class eve.ui.Container

add, completeAddPopupControl, containerHasFocus, dismantle, doHotKey, doPaint, findChild, findChild, focusFirst, focusFirst, focusOnContainer, focusOnData, getChildren, getFirstFocus, getNextKeyFocus, gotFocus, grayOut, hide, lostFocus, relayout, removePopupControl, repaintDataNow, setHidden, startAddPopupControl, takeFocus, takePromptControl, unhide

Methods inherited from class eve.ui.Control

acceptsData, activate, addListener, amOnTopFrame, applyFontChange, baseOnPenEvent, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, bufferGraphics, cache, calculateTextSize, calculateTextSize, calculateTextSize, cancelHoldDown, cancelPenPress, canEdit, change, changeDimension, changeTag, checkClipboardOperations, checkExitKey, checkMenu, checkMenuKey, checkModifiers, checkParentInterceptsUIEvent, checkPenTransparent, childrenPainted, clearTag, clipboardToString, clipboardTransfer, closeMenu, contains, contains, createNewMenu, dataAccepted, dataBeingRemoved, dataDraggedOff, dataDraggedOver, dataDraggedOver, dataDroppedOn, dataTransferCancelled, deactivate, defaultTo, deferInWindowThread, doAction, doActionKey, doBackground, doMenu, dontAcceptDrop, doPaintChildren, doPaintData, doPaintData, doShowMenu, dragged, draw, draw, draw, exitEntry, fillBackground, fillBackgroundNotInFrame, findTagInParents, fontChanged, free, fromClipboard, fromField, fromField, getAllDescendants, getAllSubControls, getAncestor, getAncestor, getAncestorProperty, getBackground, getCached, getCachedChildren, getCachedDim, getCachedDim, getCachedRect, getCachedRect, getCachedSubControls, getChildAnchor, getChildren, getChildrenBackwards, getClipboardMenu, getClipObject, getContentsInsets, getContentsInsets, getContentsRect, getDataToCopy, getDataToDragAndDrop, getDim, getDisplayText, getDragAndDropContext, getFieldTransfer, getFont, getFontMetrics, getFontMetrics, getFontMetricsForSizeCalculations, getForeground, getFrame, getFrameOrContainer, getGraphics, getGraphics, getHeight, getHideParent, getImage, getLastSelected, getLocation, getLock, getMaximumSize, getMenu, getMinimumSize, getModifiedBorderFlags, getModifiers, getNext, getPaintParameters, getParent, getParent, getParent, getParentOrListener, getPasswordCharacter, getPosInFrame, getPosInFrame, getPosInParent, getPosInParent, getPreferredSize, getPreferredSizeByParent, getPreferredTextSize, getPrompt, getPromptText, getRect, getRect, getServer, getSize, getSizes, getSubControls, getTag, getText, getToolTip, getWidth, getWindow, getWindowGraphics, hasModifier, hasPopupFormAttached, hasTag, hide, inheritModifiers, insetToContents, interceptChildUIEvent, isChildOf, isDirectChildOfWindow, isHidden, isModal, isOnMe, isOnMe, isOnMe, isSomeonesHotKey, makeFrameTopMost, makeHot, makeHot, makeInvisible, makeVisible, markAsTemporaryError, menuIsActive, menuStateChanged, modify, modifyAll, modifyAll, modifyFlags, mouseHover, newEventThread, notifyAction, notifyDataChange, notifyDataChange, notifyMenuItemSelected, notifyStructureChanged, onKeyEvent, onLabelPenEvent, onPenEvent, paintBackground, paintWithControlPainter, pauseEventThread, penClicked, penDoubleClicked, penHeld, penPressed, penReleased, penRightReleased, popupBeep, popupMenuClosed, popupMenuEvent, popupMenuEvent, postEvent, postInWindowThread, postUIEvent, putInside, queueKeyEvent, queuePenEvent, readLock, recalculatePreferredSize, redisplay, refresh, releaseBufferedGraphics, removed, removeListener, repaint, repaint, repaintInWindowThread, repaintInWindowThread, repaintNow, repaintNow, repaintNow, repaintNow, requestPaint, requestResizeTo, resetAllCachedProperties, resetCachedProperties, resetRect, restore, restoreBorderModifiers, restoreFlags, resumeEventThread, scrollAndRepaint, sendToListeners, set, setAllFonts, setBackgroundImage, setBorder, setBorderModifiers, setCell, setChildAnchor, setClipObject, setControl, setCursor, setFieldTransfer, setFixedSize, setFont, setFontChange, setFreeDragging, setHidden, setHiddenParent, setHotKey, setHotKey, setLocation, setMaximumSize, setMenu, setMinimumSize, setPreferredSize, setPreferredTextSize, setPreferredTextSize, setPromptControl, setRect, setRect, setScaledBackgroundImage, setServer, setShadow, setSwiping, setTag, setTags, setTextSize, setTiledBackgroundImage, setToolTip, showHoldDownIndicator, simulateClickOn, simulateKeyPresses, simulateKeyType, standardOnKeyEvent, startDragAndDrop, startDragAndDrop, startDragging, stopDragging, takeData, takeFromClipboard, testInWindowThread, ticked, tipIsDisplayed, toClipboard, toField, toField, toIDString, toString, toTextData, transferPenPress, transferPenPress, tryDragAndDrop, tryGetGraphics, tryNext, tryStartMenu, unhide, unlock, updateData, updateDCDuringDD, updateFrom, updateTo, verifyWantDrag, verifyWantHoldDown, waitEventThread, willAcceptDrop, willShowFrame, windowHasFloatingControls, writeLock

Methods inherited from class eve.ui.ControlBase

doubleSizeIt, getGuiTextHeight, isDoubleSized, isDoubleSizedFont, loadImage, tryLoadImage

Methods inherited from class java.lang.Object

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

Methods inherited from interface eve.ui.ScrollClient

getServer, setServer

Field Detail

items

public Vector items

These are the items being edited.

confirmDelete

public boolean confirmDelete

newDoesNotCopyFromModel

public boolean newDoesNotCopyFromModel

newItemFieldName

public static final String newItemFieldName

See Also:

Constant Field Values

deleteItemFieldName

public static final String deleteItemFieldName

See Also:

Constant Field Values

upIcon

public static IImage upIcon

downIcon

public static IImage downIcon

topIcon

public static IImage topIcon

bottomIcon

public static IImage bottomIcon

editIcon

public static IImage editIcon

model

public Object model

itemName

public String itemName

This is the name of the item being edited.

list

public List list

This is the list of items.

UPDOWN_BUTTONS

public static final int UPDOWN_BUTTONS

See Also:

Constant Field Values

TOPBOTTOM_BUTTONS

public static final int TOPBOTTOM_BUTTONS

See Also:

Constant Field Values

DELETE_BUTTON

public static final int DELETE_BUTTON

See Also:

Constant Field Values

NEW_BUTTON

public static final int NEW_BUTTON

See Also:

Constant Field Values

EDIT_BUTTON

public static final int EDIT_BUTTON

See Also:

Constant Field Values

TOOL_BUTTON

public static final int TOOL_BUTTON

See Also:

Constant Field Values

ALL_BUTTONS

public static final int ALL_BUTTONS

See Also:

Constant Field Values

ALL_BUTTONS_EXCEPT_TOOLS

public static final int ALL_BUTTONS_EXCEPT_TOOLS

See Also:

Constant Field Values

OPTION_NO_LIST_MANIPULATION

public static final int OPTION_NO_LIST_MANIPULATION

See Also:

Constant Field Values

OPTION_DO_VSPLIT

public static final int OPTION_DO_VSPLIT

See Also:

Constant Field Values

OPTION_DO_HSPLIT

public static final int OPTION_DO_HSPLIT

See Also:

Constant Field Values

OPTION_EDITOR_BEFORE_LIST

public static final int OPTION_EDITOR_BEFORE_LIST

See Also:

Constant Field Values

OPTION_EDITOR_AFTER_LIST

public static final int OPTION_EDITOR_AFTER_LIST

See Also:

Constant Field Values

OPTION_DONT_SETUP

public static final int OPTION_DONT_SETUP

This option when used with a constructor tells the ListEditor not to do the setup. You will have to explicitly call setup() afterwards.

See Also:

Constant Field Values

OPTION_TOOL_BUTTONS_IN_SCROLL_BAR

public static final int OPTION_TOOL_BUTTONS_IN_SCROLL_BAR

See Also:

Constant Field Values

OPTION_NO_SPLITTABLE_PANEL

public static final int OPTION_NO_SPLITTABLE_PANEL

See Also:

Constant Field Values

listTitle

public String listTitle

toolsMenu

public Menu toolsMenu

newMenu

public MenuItem newMenu

deleteMenu

public MenuItem deleteMenu

toolMenuItem

public MenuItem toolMenuItem

contextMenuItem

public MenuItem contextMenuItem

vSplit

public boolean vSplit

If a splittable panel is used, this says if the two sections are vertically laid out.

display

public Editor display

editor

public Editor editor

defaultEditor

public Editor defaultEditor

useSplittablePanel

public boolean useSplittablePanel

editorOnTop

public boolean editorOnTop

listRows

public int listRows

listColumns

public int listColumns

underList

protected CellPanel underList

Constructor Detail

ListEditor

public ListEditor()

This constructor does no setup whatsoever - you will have to call setup() yourself.

ListEditor

public ListEditor(LiveData forWhat,
                  int display,
                  int editor,
                  int defaultEditor,
                  boolean vertical,
                  int buttonsAndOptions)

ListEditor

public ListEditor(Object forWhat,
                  boolean vertical,
                  int buttonsAndOptions)

Method Detail

getIcon

public static IImage getIcon(String image)

getListOwner

public Object getListOwner(Class ownerClass)

getEditor

public Editor getEditor(Object ld,
                        int editor)

setup

public void setup(LiveData forWhat,
                  int display,
                  int editor,
                  int defaultEditor,
                  boolean vertical,
                  int buttonsAndOptions)

Call this after using the constructor with the same parameters ONLY if OPTION_DONT_SETUP was included in buttonsAndOptions when the constructor was called.

Parameters:

forWhat -

display -

editor -

defaultEditor -

vertical -

buttonsAndOptions -

setup

public void setup(Object forWhat,
                  boolean vertical,
                  int buttonsAndOptions)

Call this after using the constructor with the same parameters ONLY if OPTION_DONT_SETUP was included in buttonsAndOptions when the constructor was called.

Parameters:

forWhat -

vertical -

buttonsAndOptions -

setData

public void setData(Object what)

Set the list of items. The what parameter must be a Vector or an Object[]. If it is a Vector, then the "items" field is set to it - otherwise a new Vector is created to hold all the elements of the array and that is assigned to "items".

Overrides:

setData in class Editor

getData

public void getData(Object obj)

Get the list of items. The what parameter must be a Vector. The Vector is first cleared and then all the items in the "items" field is copied into it.

Overrides:

getData in class Editor

getItemCount

public int getItemCount()

Get the number of items.

getItem

public Object getItem(int index)

Get the item at the specified index.

Parameters:

index - The index of the item to get.

Returns:

The item at the index.

getNameFor

public String getNameFor(Object item)

Get the name for the item. By default if it is a LiveData, it will return getName(), otherwise it will return item.toString();

getToPutInList

public Object getToPutInList(Object item)

make

public void make(boolean reMake)

Description copied from class: Container

This is used to "make" the control before being displayed.

Overrides:

make in class Editor

Parameters:

reMake - if this is true then you should do a full re-make.

addButton

protected Button addButton(CellPanel addTo,
                           boolean vertical,
                           String image,
                           String title,
                           String field)

addButton

protected Button addButton(CellPanel addTo,
                           boolean vertical,
                           IImage mi,
                           String title,
                           String field)

getToolBar

public Control getToolBar(boolean vertical,
                          int buttons)

getToolBar

public Control getToolBar(boolean vertical,
                          int buttons,
                          boolean allowReconfigurable)

getDataEditor

public Editor getDataEditor()

titleList

protected void titleList(String listTitle)

setListTitle

public void setListTitle(String listTitle)

getUseNewItem

public static MenuItem getUseNewItem(FontMetrics fm,
                                     String itemName)

doStandardSetup

public void doStandardSetup(boolean verticalToolBar,
                            int buttonsAndOptions,
                            Editor toDisplay,
                            Editor toEdit,
                            Editor defaultEditor)

itemsChanged

public void itemsChanged(boolean doNotify,
                         int select)

newSelected

protected void newSelected(int idx)

shown

public void shown()

Description copied from class: Control

This is called when a Control is shown in a Window. Always call super.shown() if you override this.

Overrides:

shown in class Editor

getNewObject

public Object getNewObject()

Create and return a new default Object.

nameChanged

public void nameChanged(int idx)

This should be called if an item has its display name changed.

doDelete

public void doDelete(int idx,
                     boolean doNotify)

execEditor

protected boolean execEditor(Object toEdit,
                             Editor editor)

doEdit

public void doEdit(int idx)

doAddNew

public void doAddNew(Object toAdd,
                     int index,
                     boolean doNotify)

This adds a new item or items (an array of Objects can be provided) as if the user had pressed the New Item button.

Parameters:

toAdd - The object to add or an array of Objects.

index - The index to put the new object in. If it is -1 then it is added to the end.

doNotify - If this is true then a standard DataChanged event is generated.

doAddNew

public final void doAddNew(Object toAdd)

This adds a new item as if the user had pressed the New Item button. It calls doAddNew(toAdd,-1,true);

Parameters:

toAdd - The object to add.

shift

protected void shift(int idx,
                     int dx)

action

public void action(FieldTransfer ft,
                   Editor ed)

Description copied from class: Editor

This implements the action() method in FieldListener. By default it calls action(String name,Editor ed)

Specified by:

action in interface FieldListener

Overrides:

action in class Editor

action

public void action(String name,
                   Editor ed)

Description copied from class: Editor

This gets called by action(FieldTransfer ft,Editor ed) and by fieldChanged(FieldTransfer ft,Editor ed) if the field changed is a menu item. By default it will look for a method called void _action(Editor ed) and if it finds it, it will be executed.

Overrides:

action in class Editor

fieldEvent

public void fieldEvent(FieldTransfer ft,
                       Editor ed,
                       Object event)

Description copied from class: Editor

This implements fieldEvent() in FieldListener. By default it does nothing.

Specified by:

fieldEvent in interface FieldListener

Overrides:

fieldEvent in class Editor

editingObjectChanged

protected void editingObjectChanged(Object editing)

Called when the selected item has changed.

Parameters:

editing - the object being edited.

displayInListChanged

protected boolean displayInListChanged(MenuItem was,
                                       Object changed)

This is called if the Editor indicates that the Object currently being has changed in some way. By default this method compares the name of the Object with the label in the MenuItem.

Parameters:

was - the MenuItem of the edited object as it appears in the list.

changed - the Object that has been changed in some way.

Returns:

true if the list needs updating, false if not.

fieldChanged

public void fieldChanged(FieldTransfer ft,
                         Editor ed)

Description copied from class: Editor

This implements the fieldChanged() method in FieldListener. If the field is of type MenuItem then action(String fieldName,Editor ed) method is called - where fieldName is set to be the "action" value for the MenuItem.

Specified by:

fieldChanged in interface FieldListener

Overrides:

fieldChanged in class Editor