org.dishevelled.eventlist.view

Class ElementsSummary<E>

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

org.dishevelled.eventlist.view.AbstractEventListView<E>

org.dishevelled.eventlist.view.ElementsSummary<E>

Type Parameters:

E - model element type

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, EventListView<E>

Direct Known Subclasses:

IdElementsSummary

public class ElementsSummary<E>
extends AbstractEventListView<E>

Elements summary.

Author:

Michael Heuer

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.dishevelled.eventlist.view.AbstractEventListView

AbstractEventListView.ListSelectionModelAdapter

Nested classes/interfaces inherited from class javax.swing.JPanel

JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ELEMENTS_TO_DISPLAY Default number of elements to display, 3.
static Icon	DEFAULT_INDICATOR_ICON Default more elements indicator icon, null.
static String	DEFAULT_INDICATOR_TEXT Default more elements indicator text, ....
static Icon	DEFAULT_SEPARATOR_ICON Default separator icon between elements, null.
static String	DEFAULT_SEPARATOR_TEXT Default separator text between elements, , .

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ElementsSummary(ca.odell.glazedlists.EventList<E> model) Create a new elements summary with the specified model.
	ElementsSummary(ca.odell.glazedlists.EventList<E> model, UnaryFunction<E,? extends JComponent> modelToView) Create a new elements summary with the specified model and model to view mapping.

Method Summary

Modifier and Type	Method and Description
void	add() Add.
protected void	copy(List<E> toCopy) Copy the specific list of elements to the clipboard.
protected void	cut(List<E> toCut) Cut the specific list of elements to the clipboard.
void	dispose() Release the resources consumed by this abstract event list view so that it may eventually be garbage collected.
int	getElementsToDisplay() Return the number of elements to display.
Icon	getIndicatorIcon() Return the more elements indicator icon.
String	getIndicatorText() Return the more elements indicator text.
String	getSeparator() Return the separator text between elements.
Icon	getSeparatorIcon() Return the separator icon between elements.
void	paste() Paste.
void	setElementsToDisplay(int elementsToDisplay) Set the number of elements to display to elementsToDisplay.
void	setIndicatorIcon(Icon indicatorIcon) Set the more elements indicator icon to indicatorIcon.
void	setIndicatorText(String indicatorText) Set the more elements indicator text to indicatorText.
protected void	setModelToView(UnaryFunction<E,? extends JComponent> modelToView) Set the model to view mapping for this elements summary to modelToView.
void	setSeparatorIcon(Icon separatorIcon) Set the separator icon between elements to separatorIcon.
void	setSeparatorText(String separatorText) Set the separator text between elements to separatorText.
protected void	updateComponents() Update components.

Methods inherited from class org.dishevelled.eventlist.view.AbstractEventListView

clear, clearSelection, copy, createToolBarPanel, cut, getAddAction, getClearSelectionAction, getContextMenu, getContextMenuButton, getCopyAction, getCutAction, getInvertSelectionAction, getLabel, getListSelectionModelAdapter, getModel, getPasteAction, getRemoveAction, getRemoveAllAction, getSelectAllAction, getSelectionModel, getToolBar, getToolBarContextMenu, invertSelection, isEmpty, isSelectionEmpty, remove, selectAll

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ELEMENTS_TO_DISPLAY

public static final int DEFAULT_ELEMENTS_TO_DISPLAY

Default number of elements to display, 3.

See Also:

Constant Field Values

DEFAULT_SEPARATOR_TEXT

public static final String DEFAULT_SEPARATOR_TEXT

Default separator text between elements, , .

See Also:

Constant Field Values

DEFAULT_SEPARATOR_ICON

public static final Icon DEFAULT_SEPARATOR_ICON

Default separator icon between elements, null.

DEFAULT_INDICATOR_TEXT

public static final String DEFAULT_INDICATOR_TEXT

Default more elements indicator text, ....

See Also:

Constant Field Values

DEFAULT_INDICATOR_ICON

public static final Icon DEFAULT_INDICATOR_ICON

Default more elements indicator icon, null.

Constructor Detail

ElementsSummary

protected ElementsSummary(ca.odell.glazedlists.EventList<E> model)

Create a new elements summary with the specified model.

Parameters:

model - model, must not be null

ElementsSummary

public ElementsSummary(ca.odell.glazedlists.EventList<E> model,
                       UnaryFunction<E,? extends JComponent> modelToView)

Create a new elements summary with the specified model and model to view mapping.

Parameters:

model - model, must not be null

modelToView - model to view mapping, must not be null

Method Detail

setModelToView

protected final void setModelToView(UnaryFunction<E,? extends JComponent> modelToView)

Set the model to view mapping for this elements summary to modelToView.

Parameters:

modelToView - model to view mapping, must not be null

getElementsToDisplay

public final int getElementsToDisplay()

Return the number of elements to display.

Returns:

the number of elements to display

setElementsToDisplay

public final void setElementsToDisplay(int elementsToDisplay)

Set the number of elements to display to elementsToDisplay. Defaults to DEFAULT_ELEMENTS_TO_DISPLAY.

This is a bound property.

Parameters:

elementsToDisplay - the number of elements to display, must be at least zero

getSeparator

public final String getSeparator()

Return the separator text between elements.

Returns:

the separator text between elements

setSeparatorText

public final void setSeparatorText(String separatorText)

Set the separator text between elements to separatorText. Defaults to DEFAULT_SEPARATOR_TEXT.

This is a bound property.

Parameters:

separatorText - separator text between elements

getSeparatorIcon

public final Icon getSeparatorIcon()

Return the separator icon between elements.

Returns:

the separator icon between elements

setSeparatorIcon

public final void setSeparatorIcon(Icon separatorIcon)

Set the separator icon between elements to separatorIcon. Defaults to DEFAULT_SEPARATOR_ICON.

This is a bound property.

Parameters:

separatorIcon - separator icon between elements

getIndicatorText

public final String getIndicatorText()

Return the more elements indicator text.

Returns:

the more elements indicator text

setIndicatorText

public final void setIndicatorText(String indicatorText)

Set the more elements indicator text to indicatorText. Defaults to DEFAULT_INDICATOR_TEXT.

This is a bound property.

Parameters:

indicatorText - more elements indicator text

getIndicatorIcon

public final Icon getIndicatorIcon()

Return the more elements indicator icon.

Returns:

the more elements indicator icon

setIndicatorIcon

public final void setIndicatorIcon(Icon indicatorIcon)

Set the more elements indicator icon to indicatorIcon. Defaults to DEFAULT_INDICATOR_ICON.

This is a bound property.

Parameters:

indicatorIcon - more elements indicator icon

cut

protected void cut(List<E> toCut)

Description copied from class: AbstractEventListView

Cut the specific list of elements to the clipboard.

Specified by:

cut in class AbstractEventListView<E>

Parameters:

toCut - list of elements to cut, must not be null

copy

protected void copy(List<E> toCopy)

Description copied from class: AbstractEventListView

Copy the specific list of elements to the clipboard.

Specified by:

copy in class AbstractEventListView<E>

Parameters:

toCopy - list of elements to copy, must not be null

add

public void add()

Description copied from class: AbstractEventListView

Add.

Specified by:

add in class AbstractEventListView<E>

paste

public void paste()

Description copied from class: AbstractEventListView

Paste.

Specified by:

paste in class AbstractEventListView<E>

updateComponents

protected final void updateComponents()

Update components.

dispose

public void dispose()

Description copied from class: AbstractEventListView

Release the resources consumed by this abstract event list view so that it may eventually be garbage collected. Subclasses that override this method should call super.dispose().

Overrides:

dispose in class AbstractEventListView<E>