org.tbee.swing.jpa
Class JpaObjectNavigatorModel<T>

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  org.tbee.swing.jpa.JpaObjectNavigatorModel<T>

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class JpaObjectNavigatorModel<T>
extends javax.swing.JPanel

Version:

$Revision: 1.65 $

See Also:

Serialized Form

Nested Class Summary

static class	JpaObjectNavigatorModel.AbstractQuicksearchExtender<T> The base class
static class	JpaObjectNavigatorModel.EntityChangeEvent<T>
static interface	JpaObjectNavigatorModel.JpaObjectNavigatorListener<T> The listeners event
static class	JpaObjectNavigatorModel.JpaObjectNavigatorListenerDefaultImpl<T> to make life easier (and prevent troubles when the interface is extended), better extend this one
static interface	JpaObjectNavigatorModel.QuicksearchExtender<T> The interface
static class	JpaObjectNavigatorModel.StatusMessage<T>

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

javax.swing.JPanel.AccessibleJPanel

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

javax.swing.JComponent.AccessibleJComponent

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

java.awt.Container.AccessibleAWTContainer

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

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static java.lang.String	ALLOW_DELETE_PROPERTY_ID
static java.lang.String	ALLOW_NAVIGATION_PROPERTY_ID
static java.lang.String	ALLOW_NEW_PROPERTY_ID
static java.lang.String	ALLOW_QUICKSEARCH_PROPERTY_ID
static java.lang.String	ALLOW_SAVE_PROPERTY_ID
static java.lang.String	ALLOW_SEARCH_PROPERTY_ID
static java.lang.String	ASYNC_PROPERTY_ID
static java.lang.String	ENABLE_DELETE_PROPERTY_ID
static java.lang.String	ENABLE_NAVIGATION_PROPERTY_ID
static java.lang.String	ENABLE_NEW_PROPERTY_ID
static java.lang.String	ENABLE_QUICKSEARCH_PROPERTY_ID
static java.lang.String	ENABLE_SAVE_PROPERTY_ID
static java.lang.String	ENABLE_SEARCH_PROPERTY_ID
static java.lang.String	FILTERING_PROPERTY_ID
static java.lang.String	NEWAFTERSAVE_PROPERTY_ID

Fields inherited from class javax.swing.JComponent

accessibleContext, 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

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

JpaObjectNavigatorModel(java.lang.Class entityClass, java.lang.String pkName, java.lang.String pkGetMethodName, java.lang.String[] alternateQuicksearchFields)

Method Summary

void	addJpaObjectNavigatorListener(JpaObjectNavigatorModel.JpaObjectNavigatorListener l) listen to any EntityChanged
void	addPropertyChangeListener(java.beans.PropertyChangeListener o) PropertyChange
void	addQuicksearchExtender(JpaObjectNavigatorModel.QuicksearchExtender<T> extender)
void	clearCaches()
void	clearFilter()
boolean	doDelete()
boolean	doDelete(boolean fireStartingNewAction)
boolean	doFilter(java.util.List<T> entities, T entity)
boolean	doFilter(java.util.List<T> entities, T entity, boolean fireStartingNewAction)
boolean	doFirst()
boolean	doFirst(boolean fireStartingNewAction)
boolean	doGoto(int filterIdx)
boolean	doGoto(int filterIdx, boolean fireStartingNewAction)
boolean	doGoto(T value)
boolean	doGoto(T value, boolean fireStartingNewAction)
boolean	doLast()
boolean	doLast(boolean fireStartingNewAction)
boolean	doLoad()
boolean	doNew()
boolean	doNew(boolean fireStartingNewAction)
boolean	doNext()
boolean	doNext(boolean fireStartingNewAction)
boolean	doPrevious()
boolean	doPrevious(boolean fireStartingNewAction)
boolean	doQuickSearch(java.lang.String id)
boolean	doSave()
boolean	doSave(boolean fireStartingNewAction)
void	duringDeletePostRemove(T entity)
void	duringDeletePreRemove()
void	duringSavePostMerge(T entity)
void	duringSavePreMerge()
boolean	fireAllowDelete()
boolean	fireAllowEntityChange()
boolean	fireAllowSave()
void	fireEntityChanged(JpaObjectNavigatorModel.EntityChangeEvent<T> e)
void	fireFilterChanged(java.util.List<java.lang.Object> filter)
void	firePermissionsChanged()
void	firePropertyChange(java.lang.String name, java.lang.Object before, java.lang.Object after)
void	fireStatusMessage(JpaObjectNavigatorModel.StatusMessage<T> sm)
boolean	getAllowDelete() AllowDelete
boolean	getAllowNavigation() AllowNavigation
boolean	getAllowNew() AllowNew
boolean	getAllowQuicksearch() AllowQuicksearch
boolean	getAllowSave() AllowSave
boolean	getAllowSearch() AllowSearch
java.lang.String[]	getAlternateQuicksearchFields() AlternateQuicksearchFields
boolean	getAsync() Async Running asynchronous is not trivial, the most important thing being the blocking of the components being saved.
boolean	getEnableDelete() EnableDelete
boolean	getEnableNavigation() EnableNavigation
boolean	getEnableNew() EnableNew
boolean	getEnableQuicksearch() EnableQuicksearch
boolean	getEnableSave() EnableSave
boolean	getEnableSearch() EnableSearch
T	getEntity() Entity
java.lang.Class	getEntityClass() EntityClass
int	getFilterIndex() FilterIndex
int	getFilterSize() FilterSize
boolean	getNewAfterSave() NewAfterSave
java.lang.String	getPkGetMethodName() PkGetMethodName
java.lang.String	getPkName() PkName
boolean	isBusy() Busy
boolean	isFiltering() Filtering
void	postDelete(T entity)
void	postLoad()
void	postNew()
void	postSave(T entity)
void	preDelete()
void	preLoad()
void	preNew()
void	preSave()
void	removeJpaObjectNavigatorListener(JpaObjectNavigatorModel.JpaObjectNavigatorListener l)
void	removePropertyChangeListener(java.beans.PropertyChangeListener o)
void	removeQuicksearchExtender(JpaObjectNavigatorModel.QuicksearchExtender<T> extender)
void	setAllowDelete(boolean value)
void	setAllowNavigation(boolean value)
void	setAllowNew(boolean value)
void	setAllowQuicksearch(boolean value)
void	setAllowSave(boolean value)
void	setAllowSearch(boolean value)
void	setAlternateQuicksearchFields(java.lang.String[] value)
void	setAsync(boolean value)
void	setEnableDelete(boolean value)
void	setEnableNavigation(boolean value)
void	setEnableNew(boolean value)
void	setEnableQuicksearch(boolean value)
void	setEnableSave(boolean value)
void	setEnableSearch(boolean value)
void	setEntity(T value)
void	setEntityClass(java.lang.Class value)
void	setNewAfterSave(boolean value)
void	setPkGetMethodName(java.lang.String value)
void	setPkName(java.lang.String value)
boolean	setQuicksearchResult(java.util.List<T> lEntities) Examine the result of a search and set it

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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, 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, 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, transferFocusBackward, 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, 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, hide, 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, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

FILTERING_PROPERTY_ID

public static final java.lang.String FILTERING_PROPERTY_ID

See Also:

Constant Field Values

NEWAFTERSAVE_PROPERTY_ID

public static final java.lang.String NEWAFTERSAVE_PROPERTY_ID

See Also:

Constant Field Values

ASYNC_PROPERTY_ID

public static final java.lang.String ASYNC_PROPERTY_ID

See Also:

Constant Field Values

ALLOW_NEW_PROPERTY_ID

public static final java.lang.String ALLOW_NEW_PROPERTY_ID

See Also:

Constant Field Values

ALLOW_SAVE_PROPERTY_ID

public static final java.lang.String ALLOW_SAVE_PROPERTY_ID

See Also:

Constant Field Values

ALLOW_DELETE_PROPERTY_ID

public static final java.lang.String ALLOW_DELETE_PROPERTY_ID

See Also:

Constant Field Values

ALLOW_NAVIGATION_PROPERTY_ID

public static final java.lang.String ALLOW_NAVIGATION_PROPERTY_ID

See Also:

Constant Field Values

ALLOW_SEARCH_PROPERTY_ID

public static final java.lang.String ALLOW_SEARCH_PROPERTY_ID

See Also:

Constant Field Values

ALLOW_QUICKSEARCH_PROPERTY_ID

public static final java.lang.String ALLOW_QUICKSEARCH_PROPERTY_ID

See Also:

Constant Field Values

ENABLE_NEW_PROPERTY_ID

public static final java.lang.String ENABLE_NEW_PROPERTY_ID

See Also:

Constant Field Values

ENABLE_SAVE_PROPERTY_ID

public static final java.lang.String ENABLE_SAVE_PROPERTY_ID

See Also:

Constant Field Values

ENABLE_DELETE_PROPERTY_ID

public static final java.lang.String ENABLE_DELETE_PROPERTY_ID

See Also:

Constant Field Values

ENABLE_NAVIGATION_PROPERTY_ID

public static final java.lang.String ENABLE_NAVIGATION_PROPERTY_ID

See Also:

Constant Field Values

ENABLE_SEARCH_PROPERTY_ID

public static final java.lang.String ENABLE_SEARCH_PROPERTY_ID

See Also:

Constant Field Values

ENABLE_QUICKSEARCH_PROPERTY_ID

public static final java.lang.String ENABLE_QUICKSEARCH_PROPERTY_ID

See Also:

Constant Field Values

Constructor Detail

JpaObjectNavigatorModel

public JpaObjectNavigatorModel(java.lang.Class entityClass,
                               java.lang.String pkName,
                               java.lang.String pkGetMethodName,
                               java.lang.String[] alternateQuicksearchFields)

Parameters:

entityClass -

pkName -

pkGetMethodName -

Method Detail

getEntityClass

public java.lang.Class getEntityClass()

EntityClass

setEntityClass

public void setEntityClass(java.lang.Class value)

getPkName

public java.lang.String getPkName()

PkName

setPkName

public void setPkName(java.lang.String value)

getAlternateQuicksearchFields

public java.lang.String[] getAlternateQuicksearchFields()

AlternateQuicksearchFields

setAlternateQuicksearchFields

public void setAlternateQuicksearchFields(java.lang.String[] value)

getPkGetMethodName

public java.lang.String getPkGetMethodName()

PkGetMethodName

setPkGetMethodName

public void setPkGetMethodName(java.lang.String value)

getEntity

public T getEntity()

Entity

setEntity

public void setEntity(T value)

isFiltering

public boolean isFiltering()

Filtering

clearFilter

public void clearFilter()

getFilterIndex

public int getFilterIndex()

FilterIndex

getFilterSize

public int getFilterSize()

FilterSize

getNewAfterSave

public boolean getNewAfterSave()

NewAfterSave

setNewAfterSave

public void setNewAfterSave(boolean value)

getAsync

public boolean getAsync()

Async Running asynchronous is not trivial, the most important thing being the blocking of the components being saved. So per default we are not asynchronous. When running async, the busy property will indicate if we are busy.

setAsync

public void setAsync(boolean value)

isBusy

public boolean isBusy()

Busy

getAllowNew

public boolean getAllowNew()

AllowNew

setAllowNew

public void setAllowNew(boolean value)

getAllowSave

public boolean getAllowSave()

AllowSave

setAllowSave

public void setAllowSave(boolean value)

getAllowDelete

public boolean getAllowDelete()

AllowDelete

setAllowDelete

public void setAllowDelete(boolean value)

getAllowNavigation

public boolean getAllowNavigation()

AllowNavigation

setAllowNavigation

public void setAllowNavigation(boolean value)

getAllowSearch

public boolean getAllowSearch()

AllowSearch

setAllowSearch

public void setAllowSearch(boolean value)

getAllowQuicksearch

public boolean getAllowQuicksearch()

AllowQuicksearch

setAllowQuicksearch

public void setAllowQuicksearch(boolean value)

getEnableNew

public boolean getEnableNew()

EnableNew

setEnableNew

public void setEnableNew(boolean value)

getEnableSave

public boolean getEnableSave()

EnableSave

setEnableSave

public void setEnableSave(boolean value)

getEnableDelete

public boolean getEnableDelete()

EnableDelete

setEnableDelete

public void setEnableDelete(boolean value)

getEnableNavigation

public boolean getEnableNavigation()

EnableNavigation

setEnableNavigation

public void setEnableNavigation(boolean value)

getEnableSearch

public boolean getEnableSearch()

EnableSearch

setEnableSearch

public void setEnableSearch(boolean value)

getEnableQuicksearch

public boolean getEnableQuicksearch()

EnableQuicksearch

setEnableQuicksearch

public void setEnableQuicksearch(boolean value)

doFirst

public boolean doFirst()

doFirst

public boolean doFirst(boolean fireStartingNewAction)

doPrevious

public boolean doPrevious()

doPrevious

public boolean doPrevious(boolean fireStartingNewAction)

doNext

public boolean doNext()

doNext

public boolean doNext(boolean fireStartingNewAction)

doLast

public boolean doLast()

doLast

public boolean doLast(boolean fireStartingNewAction)

doGoto

public boolean doGoto(T value)

doGoto

public boolean doGoto(T value,
                      boolean fireStartingNewAction)

doGoto

public boolean doGoto(int filterIdx)

doGoto

public boolean doGoto(int filterIdx,
                      boolean fireStartingNewAction)

doFilter

public boolean doFilter(java.util.List<T> entities,
                        T entity)

doFilter

public boolean doFilter(java.util.List<T> entities,
                        T entity,
                        boolean fireStartingNewAction)

doNew

public boolean doNew()

doNew

public boolean doNew(boolean fireStartingNewAction)

doLoad

public boolean doLoad()

doSave

public boolean doSave()

doSave

public boolean doSave(boolean fireStartingNewAction)

doDelete

public boolean doDelete()

doDelete

public boolean doDelete(boolean fireStartingNewAction)

doQuickSearch

public boolean doQuickSearch(java.lang.String id)

setQuicksearchResult

public boolean setQuicksearchResult(java.util.List<T> lEntities)

Examine the result of a search and set it

Parameters:

lEntities -

Returns:

clearCaches

public void clearCaches()

addJpaObjectNavigatorListener

public void addJpaObjectNavigatorListener(JpaObjectNavigatorModel.JpaObjectNavigatorListener l)

listen to any EntityChanged

removeJpaObjectNavigatorListener

public void removeJpaObjectNavigatorListener(JpaObjectNavigatorModel.JpaObjectNavigatorListener l)

fireAllowEntityChange

public boolean fireAllowEntityChange()

fireEntityChanged

public void fireEntityChanged(JpaObjectNavigatorModel.EntityChangeEvent<T> e)

fireFilterChanged

public void fireFilterChanged(java.util.List<java.lang.Object> filter)

fireAllowDelete

public boolean fireAllowDelete()

fireAllowSave

public boolean fireAllowSave()

preNew

public void preNew()

postNew

public void postNew()

preLoad

public void preLoad()

postLoad

public void postLoad()

preSave

public void preSave()

duringSavePreMerge

public void duringSavePreMerge()

duringSavePostMerge

public void duringSavePostMerge(T entity)

postSave

public void postSave(T entity)

preDelete

public void preDelete()

duringDeletePreRemove

public void duringDeletePreRemove()

duringDeletePostRemove

public void duringDeletePostRemove(T entity)

postDelete

public void postDelete(T entity)

fireStatusMessage

public void fireStatusMessage(JpaObjectNavigatorModel.StatusMessage<T> sm)

firePermissionsChanged

public void firePermissionsChanged()

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener o)

PropertyChange

Overrides:

addPropertyChangeListener in class java.awt.Container

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener o)

Overrides:

removePropertyChangeListener in class java.awt.Component

firePropertyChange

public void firePropertyChange(java.lang.String name,
                               java.lang.Object before,
                               java.lang.Object after)

Overrides:

firePropertyChange in class java.awt.Component

addQuicksearchExtender

public void addQuicksearchExtender(JpaObjectNavigatorModel.QuicksearchExtender<T> extender)

removeQuicksearchExtender

public void removeQuicksearchExtender(JpaObjectNavigatorModel.QuicksearchExtender<T> extender)