com.codename1.rad.ui.entityviews

Class EntityListView<T extends EntityList>

java.lang.Object

com.codename1.ui.Component

com.codename1.ui.Container

com.codename1.rad.ui.AbstractEntityView<T>

com.codename1.rad.ui.entityviews.EntityListView<T>

All Implemented Interfaces:

CollapsibleHeaderContainer.ScrollableContainer, EntityView<T>, Animation, Editable, StyleListener, Iterable<Component>

Direct Known Subclasses:

ProfileListView

public class EntityListView<T extends EntityList>
extends AbstractEntityView<T>
implements CollapsibleHeaderContainer.ScrollableContainer

A view that renders an EntityList visually. This will bind to the list’s events so that rows will animate in and out appropriately when they are added to the model. The list can be customized with a EntityListCellRenderer.

Author:

shannah

See Also:

ListCellRendererAttribute, RowTemplateNode

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityListView.RowLayout An enum to specify the layout used for the rows.

Field Summary

Fields

Modifier and Type	Field and Description
static ViewProperty<Boolean>	ANIMATE_INSERTIONS View property to configure whether inserting new rows should be animated.
static ViewProperty<Boolean>	ANIMATE_REMOVALS View property to configure whether removing rows should be animated.
static ViewProperty<Integer>	COLUMNS View property to specify the number of columns to use for the EntityListView.RowLayout.Grid layout.
static ViewProperty<Integer>	LANDSCAPE_COLUMNS View property to specify the number of columns to use in landscape mode for EntityListView.RowLayout.Grid
static ViewProperty<EntityListView.RowLayout>	LAYOUT View property to specify the layout of the list.
static ViewProperty<Boolean>	SCROLLABLE_X View property to configure whether the list is scrollable horizontally.
static ViewProperty<Boolean>	SCROLLABLE_Y View property to configure whether the list is scrollable vertically.

Fields inherited from class com.codename1.ui.Component

BASELINE, BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, CROSSHAIR_CURSOR, DEFAULT_CURSOR, DRAG_REGION_IMMEDIATELY_DRAG_X, DRAG_REGION_IMMEDIATELY_DRAG_XY, DRAG_REGION_IMMEDIATELY_DRAG_Y, DRAG_REGION_LIKELY_DRAG_X, DRAG_REGION_LIKELY_DRAG_XY, DRAG_REGION_LIKELY_DRAG_Y, DRAG_REGION_NOT_DRAGGABLE, DRAG_REGION_POSSIBLE_DRAG_X, DRAG_REGION_POSSIBLE_DRAG_XY, DRAG_REGION_POSSIBLE_DRAG_Y, E_RESIZE_CURSOR, HAND_CURSOR, LEFT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NW_RESIZE_CURSOR, RIGHT, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, TOP, W_RESIZE_CURSOR, WAIT_CURSOR

Constructor Summary

Constructors

Constructor and Description
EntityListView(T list)
EntityListView(T list, ListNode node) Creates a list view for the given Entity list

Method Summary

Modifier and Type	Method and Description
void	bindImpl() To be implemented by subclasses to register listeners on the model.
void	commit()
EntityListCellRenderer	getListCellRenderer()
Layout	getListLayout() Gets the layout used to render the rows of the list.
EntityView	getRowViewForEntity(Entity e)
Container	getScrollWrapper() Gets the container that is scrollable, for scrolling through rows.
Container	getVerticalScroller() A wrapper for getScrollWrapper() to conform to the CollapsibleHeaderContainer.ScrollableContainer interface.
Node	getViewNode()
boolean	isAnimateInsertions() Checks if animation of row insertions is enabled.
boolean	isAnimateRemovals() Checks if animate removals is enabled.
void	setAnimateInsertions(boolean anim) Sets whether to animate insertions into the list.
void	setAnimateRemovals(boolean anim) Sets whether to animate removes from the list.
void	setListCellRenderer(EntityListCellRenderer renderer)
void	setListLayout(Layout l) Sets the layout used to render rows of the list.
void	setScrollableY(boolean scrollableY)
void	unbindImpl() Should be overridden by subclasses to unregister listeners from the model.
void	update()

Methods inherited from class com.codename1.rad.ui.AbstractEntityView

bind, deinitialize, findProperty, getEntity, initComponent, isBindOnPropertyChangeEvents, setBindOnPropertyChangeEvents, setEntity, unbind

Methods inherited from class com.codename1.ui.Container

add, add, add, add, add, add, addAll, addComponent, addComponent, addComponent, addComponent, animateHierarchy, animateHierarchyAndWait, animateHierarchyFade, animateHierarchyFadeAndWait, animateLayout, animateLayoutAndWait, animateLayoutFade, animateLayoutFadeAndWait, animateUnlayout, animateUnlayoutAndWait, applyRTL, calcPreferredSize, cancelRepaints, clearClientProperties, constrainHeightWhenScrollable, constrainWidthWhenScrollable, contains, createAnimateHierarchy, createAnimateHierarchyFade, createAnimateLayout, createAnimateLayoutFade, createAnimateLayoutFadeAndWait, createAnimateMotion, createAnimateUnlayout, createReplaceTransition, dragInitiated, drop, encloseIn, encloseIn, findDropTargetAt, findFirstFocusable, fireClicked, flushReplace, forceRevalidate, getBottomGap, getChildrenAsList, getClosestComponentTo, getComponentAt, getComponentAt, getComponentCount, getComponentIndex, getGridPosX, getGridPosY, getLayout, getLayoutHeight, getLayoutWidth, getLeadComponent, getLeadParent, getResponderAt, getSafeAreaRoot, getScrollIncrement, getSideGap, getUIManager, initLaf, invalidate, isEnabled, isSafeArea, isSafeAreaRoot, isScrollableX, isScrollableY, isSelectableInteraction, iterator, iterator, keyPressed, keyReleased, layoutContainer, morph, morphAndWait, paint, paintComponentBackground, paintGlass, paramString, pointerPressed, refreshTheme, removeAll, removeComponent, replace, replace, replaceAndWait, replaceAndWait, replaceAndWait, revalidate, revalidateLater, revalidateWithAnimationSafety, scrollComponentToVisible, setCellRenderer, setEnabled, setLayout, setLeadComponent, setSafeArea, setSafeAreaRoot, setScrollable, setScrollableX, setScrollIncrement, setShouldCalcPreferredSize, setShouldLayout, setUIManager, updateTabIndices

Methods inherited from class com.codename1.ui.Component

addDragFinishedListener, addDragOverListener, addDropListener, addFocusListener, addLongPressListener, addPointerDraggedListener, addPointerPressedListener, addPointerReleasedListener, addPullToRefresh, addScrollListener, addStateChangeListener, animate, bindProperty, blocksSideSwipe, calcScrollSize, contains, containsOrOwns, createStyleAnimation, deinitializeCustomStyle, dragEnter, dragExit, dragFinished, draggingOver, drawDraggedImage, focusGained, focusLost, getAbsoluteX, getAbsoluteY, getAllStyles, getAnimationManager, getBaseline, getBaselineResizeBehavior, getBindablePropertyNames, getBindablePropertyTypes, getBorder, getBoundPropertyValue, getBounds, getBounds, getClientProperty, getCloudBoundProperty, getCloudDestinationProperty, getComponentForm, getComponentState, getCursor, getDirtyRegion, getDisabledStyle, getDraggedx, getDraggedy, getDragImage, getDragRegionStatus, getDragSpeed, getEditingDelegate, getHeight, getInlineAllStyles, getInlineDisabledStyles, getInlinePressedStyles, getInlineSelectedStyles, getInlineStylesTheme, getInlineUnselectedStyles, getInnerHeight, getInnerPreferredH, getInnerPreferredW, getInnerWidth, getInnerX, getInnerY, getLabelForComponent, getName, getNativeOverlay, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getOuterHeight, getOuterPreferredH, getOuterPreferredW, getOuterWidth, getOuterX, getOuterY, getOwner, getParent, getPreferredH, getPreferredSize, getPreferredSizeStr, getPreferredTabIndex, getPreferredW, getPressedStyle, getPropertyNames, getPropertyTypeNames, getPropertyTypes, getPropertyValue, getSameHeight, getSameWidth, getScrollable, getScrollAnimationSpeed, getScrollDimension, getScrollOpacity, getScrollOpacityChangeSpeed, getScrollX, getScrollY, getSelectCommandText, getSelectedRect, getSelectedStyle, getStyle, getTabIndex, getTensileLength, getTextSelectionSupport, getTooltip, getUIID, getUnselectedStyle, getVisibleBounds, getVisibleBounds, getWidth, getX, getY, growShrink, handlesInput, hasFixedPreferredSize, hasFocus, hideNativeOverlay, initCustomStyle, installDefaultPainter, isAlwaysTensile, isBlockLead, isCellRenderer, isChildOf, isDragActivated, isDragAndDropOperation, isDraggable, isDragRegion, isDropTarget, isEditable, isEditing, isFlatten, isFocusable, isGrabsPointerEvents, isHidden, isHidden, isHideInLandscape, isHideInPortrait, isIgnorePointerEvents, isInClippingRegion, isInitialized, isOpaque, isOwnedBy, isRippleEffect, isRTL, isScrollable, isScrollVisible, isSetCursorSupported, isSmoothScrolling, isSnapToGrid, isStickyDrag, isTactileTouch, isTactileTouch, isTensileDragEnabled, isTraversable, isVisible, keyRepeated, laidOut, longKeyPress, longPointerPress, onScrollX, onScrollY, paintBackground, paintBackgrounds, paintBorder, paintBorderBackground, paintComponent, paintComponent, paintIntersectingComponentsAbove, paintLock, paintLockRelease, paintRippleOverlay, paintScrollbars, paintScrollbarX, paintScrollbarY, parsePreferredSize, pinch, pinchReleased, pointerDragged, pointerDragged, pointerHover, pointerHoverPressed, pointerHoverReleased, pointerPressed, pointerReleased, pointerReleased, putClientProperty, refreshTheme, refreshTheme, remove, removeDragFinishedListener, removeDragOverListener, removeDropListener, removeFocusListener, removeLongPressListener, removePointerDraggedListener, removePointerPressedListener, removePointerReleasedListener, removeScrollListener, removeStateChangeListener, repaint, repaint, requestFocus, resetFocusable, respondsToPointerEvents, scrollRectToVisible, scrollRectToVisible, setAlwaysTensile, setBlockLead, setBoundPropertyValue, setCloudBoundProperty, setCloudDestinationProperty, setComponentState, setCursor, setDirtyRegion, setDisabledStyle, setDraggable, setDropTarget, setEditingDelegate, setFlatten, setFocus, setFocusable, setGrabsPointerEvents, setHandlesInput, setHeight, setHidden, setHidden, setHideInLandscape, setHideInPortrait, setIgnorePointerEvents, setInitialized, setInlineAllStyles, setInlineDisabledStyles, setInlinePressedStyles, setInlineSelectedStyles, setInlineStylesTheme, setInlineUnselectedStyles, setIsScrollVisible, setLabelForComponent, setName, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setOpaque, setOwner, setPreferredH, setPreferredSize, setPreferredSizeStr, setPreferredTabIndex, setPreferredW, setPressedStyle, setPropertyValue, setRippleEffect, setRTL, setSameHeight, setSameSize, setSameWidth, setScrollAnimationSpeed, setScrollOpacityChangeSpeed, setScrollSize, setScrollVisible, setScrollX, setScrollY, setSelectCommandText, setSelectedStyle, setSize, setSmoothScrolling, setSnapToGrid, setTabIndex, setTactileTouch, setTensileDragEnabled, setTensileLength, setTooltip, setTraversable, setUIID, setUIID, setUnselectedStyle, setVisible, setWidth, setX, setY, shouldBlockSideSwipe, shouldRenderComponentSelection, showNativeOverlay, startEditingAsync, stopEditing, stripMarginAndPadding, styleChanged, toImage, toString, unbindProperty, updateNativeOverlay, visibleBoundsContains

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

SCROLLABLE_Y

public static final ViewProperty<Boolean> SCROLLABLE_Y

View property to configure whether the list is scrollable vertically.

SCROLLABLE_X

public static final ViewProperty<Boolean> SCROLLABLE_X

View property to configure whether the list is scrollable horizontally.

ANIMATE_INSERTIONS

public static final ViewProperty<Boolean> ANIMATE_INSERTIONS

View property to configure whether inserting new rows should be animated.

ANIMATE_REMOVALS

public static final ViewProperty<Boolean> ANIMATE_REMOVALS

View property to configure whether removing rows should be animated.

LAYOUT

public static final ViewProperty<EntityListView.RowLayout> LAYOUT

View property to specify the layout of the list. See EntityListView.RowLayout.

COLUMNS

public static final ViewProperty<Integer> COLUMNS

View property to specify the number of columns to use for the EntityListView.RowLayout.Grid layout.

LANDSCAPE_COLUMNS

public static final ViewProperty<Integer> LANDSCAPE_COLUMNS

View property to specify the number of columns to use in landscape mode for EntityListView.RowLayout.Grid

Constructor Detail

EntityListView

public EntityListView(T list)

EntityListView

public EntityListView(T list,
                      ListNode node)

Creates a list view for the given Entity list

Parameters:

list - The view model to render.

node - Node providing configuration and actions for the view.

Method Detail

setAnimateInsertions

public void setAnimateInsertions(boolean anim)

Sets whether to animate insertions into the list. This can also be configured using the ANIMATE_INSERTIONS view property.

Parameters:

anim -

isAnimateInsertions

public boolean isAnimateInsertions()

Checks if animation of row insertions is enabled.

Returns:

setAnimateRemovals

public void setAnimateRemovals(boolean anim)

Sets whether to animate removes from the list. This can also be configured using the ANIMATE_REMOVALS view property.

isAnimateRemovals

public boolean isAnimateRemovals()

Checks if animate removals is enabled.

Returns:

getRowViewForEntity

public EntityView getRowViewForEntity(Entity e)

bindImpl

public void bindImpl()

Description copied from class: AbstractEntityView

To be implemented by subclasses to register listeners on the model.

Overrides:

bindImpl in class AbstractEntityView<T extends EntityList>

unbindImpl

public void unbindImpl()

Description copied from class: AbstractEntityView

Should be overridden by subclasses to unregister listeners from the model.

Overrides:

unbindImpl in class AbstractEntityView<T extends EntityList>

setListCellRenderer

public void setListCellRenderer(EntityListCellRenderer renderer)

getListCellRenderer

public EntityListCellRenderer getListCellRenderer()

update

public void update()

Specified by:

update in interface EntityView<T extends EntityList>

commit

public void commit()

Specified by:

commit in interface EntityView<T extends EntityList>

getViewNode

public Node getViewNode()

Specified by:

getViewNode in interface EntityView<T extends EntityList>

getScrollWrapper

public Container getScrollWrapper()

Gets the container that is scrollable, for scrolling through rows.

Returns:

getVerticalScroller

public Container getVerticalScroller()

A wrapper for getScrollWrapper() to conform to the CollapsibleHeaderContainer.ScrollableContainer interface.

Specified by:

getVerticalScroller in interface CollapsibleHeaderContainer.ScrollableContainer

Returns:

setListLayout

public void setListLayout(Layout l)

Sets the layout used to render rows of the list.

Parameters:

l - The layout used to render the list.

getListLayout

public Layout getListLayout()

Gets the layout used to render the rows of the list.

Returns:

setScrollableY

public void setScrollableY(boolean scrollableY)

Overrides:

setScrollableY in class Container