Module org.autogui

Package org.autogui.swing.log

Class GuiSwingLogList

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JList<GuiLogEntry>

org.autogui.swing.log.GuiSwingLogList

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Scrollable, GuiSwingLogManager.GuiSwingLogView

public class GuiSwingLogList
extends JList<GuiLogEntry>
implements GuiSwingLogManager.GuiSwingLogView

a list component for displaying log entries

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GuiSwingLogList.FindState	a mutable state type for searching
static class	GuiSwingLogList.GuiSwingLogEventDispatcher	the event handler for log-entries in the list
static class	GuiSwingLogList.GuiSwingLogListModel	the list model for the log-list component
static class	GuiSwingLogList.LogListClearAction	the action for clearing the log-list
static class	GuiSwingLogList.LogListCopyTextAction	the action for copying texts of log-entries
static class	GuiSwingLogList.LogListInsertResult	result information of an addition
static class	GuiSwingLogList.LogListSaveAction	the action for saving a log list to a file
static class	GuiSwingLogList.LogTextFindAdapter	the key-handler for starting searching

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

JList.AccessibleJList, JList.DropLocation

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	Description
protected Timer	activePainter
protected GuiSwingLogList.LogListClearAction	clearAction
protected GuiSwingLogList.LogListCopyTextAction	copyAction
protected GuiSwingLogList.GuiSwingLogEventDispatcher	eventDispatcher
protected GuiSwingLogManager	manager
protected Object	managerKey
protected GuiSwingLogList.LogListSaveAction	saveAction

Fields inherited from class javax.swing.JList

HORIZONTAL_WRAP, VERTICAL, VERTICAL_WRAP

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

Constructor	Description
GuiSwingLogList(GuiSwingLogManager manager)
GuiSwingLogList(GuiSwingLogManager manager, boolean addManagerAsView)

Method Summary

Modifier and Type	Method	Description
void	addLogEntry(GuiLogEntry entry)
void	addLogEntryInEvent(GuiLogEntry entry, boolean lowPriority)
void	clearLogEntries()	clear entries in the list
void	clearLogEntriesToManager()	call GuiSwingLogManager.clear() to manager.
int	convertRowIndexToModel(int r)
JToolBar	createToolBar()
void	findText(String str)	only update matching filter of existing renderer
void	findText(String str, boolean forward)	find and move
Rectangle	getCellRect(int index)
GuiSwingLogList.LogListClearAction	getClearAction()
GuiSwingLogList.LogListCopyTextAction	getCopyAction()
int	getEntryLimit()
GuiSwingLogList.GuiSwingLogListModel	getLogListModel()
int	getRowCount()
GuiSwingLogList.LogListSaveAction	getSaveAction()
List<String>	getSelectedText()
Rectangle	getTargetEntryRectForScroll(int target)
GuiLogEntry	getValueAt(int row)
boolean	isPopupVisible()
boolean	isRowSelected(int index)
void	paintActive(ActionEvent e)
protected void	paintComponent(Graphics g)
void	removeFromManager()
void	removeRowSelectionInterval(int from, int to)
int	rowAtPoint(Point p)
void	setEntryLimit(int n)
void	showPopup(Point p)
void	startActivePainter()
void	stopActivePainter()
void	updateSelectionToSelectionModel(GuiSwingLogEntry e, int index)

Methods inherited from class javax.swing.JList

addListSelectionListener, addSelectionInterval, clearSelection, createSelectionModel, ensureIndexIsVisible, fireSelectionValueChanged, getAccessibleContext, getAnchorSelectionIndex, getCellBounds, getCellRenderer, getDragEnabled, getDropLocation, getDropMode, getFirstVisibleIndex, getFixedCellHeight, getFixedCellWidth, getLastVisibleIndex, getLayoutOrientation, getLeadSelectionIndex, getListSelectionListeners, getMaxSelectionIndex, getMinSelectionIndex, getModel, getNextMatch, getPreferredScrollableViewportSize, getPrototypeCellValue, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedIndex, getSelectedIndices, getSelectedValue, getSelectedValues, getSelectedValuesList, getSelectionBackground, getSelectionForeground, getSelectionMode, getSelectionModel, getToolTipText, getUI, getUIClassID, getValueIsAdjusting, getVisibleRowCount, indexToLocation, isSelectedIndex, isSelectionEmpty, locationToIndex, paramString, removeListSelectionListener, removeSelectionInterval, setCellRenderer, setDragEnabled, setDropMode, setFixedCellHeight, setFixedCellWidth, setLayoutOrientation, setListData, setListData, setModel, setPrototypeCellValue, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectionBackground, setSelectionForeground, setSelectionInterval, setSelectionMode, setSelectionModel, setUI, setValueIsAdjusting, setVisibleRowCount, 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, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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 Details

manager

protected GuiSwingLogManager manager

activePainter

protected Timer activePainter

eventDispatcher

protected GuiSwingLogList.GuiSwingLogEventDispatcher eventDispatcher

saveAction

protected GuiSwingLogList.LogListSaveAction saveAction

clearAction

protected GuiSwingLogList.LogListClearAction clearAction

copyAction

protected GuiSwingLogList.LogListCopyTextAction copyAction

managerKey

protected Object managerKey

Constructor Details

GuiSwingLogList

public GuiSwingLogList(GuiSwingLogManager manager)

GuiSwingLogList

public GuiSwingLogList(GuiSwingLogManager manager,
 boolean addManagerAsView)

Method Details

removeFromManager

public void removeFromManager()

getSaveAction

public GuiSwingLogList.LogListSaveAction getSaveAction()

getCopyAction

public GuiSwingLogList.LogListCopyTextAction getCopyAction()

getClearAction

public GuiSwingLogList.LogListClearAction getClearAction()

getLogListModel

public GuiSwingLogList.GuiSwingLogListModel getLogListModel()

getEntryLimit

public int getEntryLimit()

setEntryLimit

public void setEntryLimit(int n)

Parameters:

n - the limit. <1 means no limit

paintComponent

protected void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

startActivePainter

public void startActivePainter()

stopActivePainter

public void stopActivePainter()

paintActive

public void paintActive(ActionEvent e)

addLogEntry

public void addLogEntry(GuiLogEntry entry)

Specified by:

addLogEntry in interface GuiSwingLogManager.GuiSwingLogView

Parameters:

entry - added entry for displaying in the view

addLogEntryInEvent

public void addLogEntryInEvent(GuiLogEntry entry,
 boolean lowPriority)

updateSelectionToSelectionModel

public void updateSelectionToSelectionModel(GuiSwingLogEntry e,
 int index)

clearLogEntries

public void clearLogEntries()

clear entries in the list

Specified by:

clearLogEntries in interface GuiSwingLogManager.GuiSwingLogView

Since:

1.2

clearLogEntriesToManager

public void clearLogEntriesToManager()

call GuiSwingLogManager.clear() to manager. it will lead to not only this doing clearLogEntries(), but also other views including status bars.

Since:

1.2

rowAtPoint

public int rowAtPoint(Point p)

isRowSelected

public boolean isRowSelected(int index)

removeRowSelectionInterval

public void removeRowSelectionInterval(int from,
 int to)

getRowCount

public int getRowCount()

getCellRect

public Rectangle getCellRect(int index)

convertRowIndexToModel

public int convertRowIndexToModel(int r)

getValueAt

public GuiLogEntry getValueAt(int row)

findText

public void findText(String str)

only update matching filter of existing renderer

Parameters:

str - the searched text

findText

public void findText(String str,
 boolean forward)

find and move

Parameters:

str - the searched text

forward - forward=true, or backward=false

getSelectedText

public List<String> getSelectedText()

getTargetEntryRectForScroll

public Rectangle getTargetEntryRectForScroll(int target)

showPopup

public void showPopup(Point p)

isPopupVisible

public boolean isPopupVisible()

createToolBar

public JToolBar createToolBar()