PdoNavigationPanel (Tentackle Swing Rich Desktop Client 8.2.7.4 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - org.tentackle.swing.FormPanel
        
        org.tentackle.swing.rdc.PdoNavigationPanel<T>

Type Parameters:

T - the pdo type

All Implemented Interfaces:

ContainerListener, KeyListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible, FormChangeable, FormContainer
```
public class PdoNavigationPanel<T extends PersistentDomainObject<T>>
extends FormPanel
implements KeyListener
```
Panel for object navigation.
The PdoNavigationPanel provides object navigation in a tree and a table in parallel. The user switches between the tree- and the table view. The tree view is primarily for navigation through object relations and operations on objects by means of a context-driven popup menu. The table view is for sorting, building sums, cutting the list and a table popup to export to spreadsheet, xml or print the table. Furthermore, other navigation panels may be created on-the-fly, for example to sum up the details (childs) of a given type for some object within a tree.

Author:

harald

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PdoNavigationPanel.ViewMode
The view mode.
- 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`PdoNavigationPanel.ViewMode` The view mode.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTION_CANCEL` "cancel" action
`static String`	`ACTION_CLOSE` "close" action
`static String`	`ACTION_SELECT` "select" action
`static int`	`SHOW_BUTTONS` show default buttons: cancel and select
`static int`	`SHOW_CANCEL` show cancel button
`static int`	`SHOW_CLOSE` show close button
`static int`	`SHOW_NOBUTTON` don't show any button
`static int`	`SHOW_SELECT` show select button

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 and Description
`PdoNavigationPanel()` Creates an empty navigation panel. This constructor makes it a bean.
`PdoNavigationPanel(List<T> list)` Creates a navigation panel. The preferences table name is determined by the first object.
`PdoNavigationPanel(List<T> list, SelectionFilter selectionFilter)` Creates a navigation panel. The preferences table name is determined by the first object.
`PdoNavigationPanel(List<T> list, SelectionFilter selectionFilter, int buttonMode, boolean showTable)` Creates a navigation panel. The preferences table name is determined by the first object.
`PdoNavigationPanel(List<T> list, SelectionFilter selectionFilter, int buttonMode, boolean showTable, String tableName)` Creates a navigation panel.
`PdoNavigationPanel(T obj)` Creates a navigation panel for a single object. The preferences table name is determined by the object.
`PdoNavigationPanel(T obj, SelectionFilter selectionFilter)` Creates a navigation panel for a single object. The preferences table name is determined by the object.
`PdoNavigationPanel(T obj, SelectionFilter selectionFilter, int buttonMode, boolean showTable)` Creates a navigation panel for a single object. The preferences table name is determined by the object.
`PdoNavigationPanel(T obj, SelectionFilter selectionFilter, int buttonMode, boolean showTable, String tableName)` Creates a navigation panel for a single object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addListSelectionListener(ListSelectionListener listener)` Adds a selection changed listener.
`void`	`addSelectionInterval(int firstIndex, int lastIndex)` Adds a selection for a given range of objects.
`void`	`clearSelection()` Clears the selections.
`FormTableModel<T>`	`createFormTableModel(FormTableEntry<T> template)` Creates the formtable model for a given object.
`FormTable<T>`	`createTable()` Creates the navigation table.
`PdoTree`	`createTree()` Creates the navigation tree.
`protected void`	`editObjectInTable(boolean changeable)` Edits the object currently selected in table.
`int`	`getButtonMode()` Gets the button mode.
`FormButton`	`getCancelButton()` Gives access to cancel button (to modify the text, i.e.)
`protected int`	`getModelIndex(int viewRow)` Gets the model row if navisorter and/or rowsorter is installed.
`FormTable<T>`	`getNaviTable()` Gives access to the table list.
`PdoTree`	`getNaviTree()` Gives access to the navigation tree.
`List<T>`	`getObjects()` Gets the current list of objects shown.
`FormButton`	`getSelectButton()` Gives access to select button (to modify the text, i.e.)
`PersistentDomainObject<?>`	`getSelectedObject()` Gets the selected object.
`List<PersistentDomainObject<?>>`	`getSelectedObjects()` Gets all selected objects.
`SelectionFilter`	`getSelectionFilter()` Gets the selection filter.
`Class<T>`	`getTableClass()` Gets the class of objects which is shown in the table.
`String`	`getTableIntro()` Gets the table intro text.
`String`	`getTableTitle()` Gets the table's title.
`T`	`getTemplateProvider()` Returns the optional tempalte provider.
`org.tentackle.misc.ObjectFilter<T>`	`getTreeFilter()` Gets the tree filter.
`protected int`	`getViewIndex(int modelRow)` Gets the view row if navisorter and/or rowsorter is installed.
`PdoNavigationPanel.ViewMode`	`getViewMode()` Gets the current viewmode
`boolean`	`isAutoPack()` Gets the pack mode.
`boolean`	`isCancelButtonVisible()` Gets the visibility of the cancel button.
`boolean`	`isCloseButtonVisible()` Gets the visibility of the select button.
`boolean`	`isDisposeKeyEnabled()` Returns whether the dispose key is enabled.
`protected boolean`	`isObjectEditedModal()` Determines whether the object should be edited modal or non-modal.
`boolean`	`isPopupEnabled()` Returns whether popup menu is allowed in the tree view.
`boolean`	`isSelectButtonVisible()` Gets the visibility of the select button.
`boolean`	`isViewModeButtonsVisible()` Gets the visibility of the tree- and table view buttons.
`void`	`keyPressed(KeyEvent e)`
`void`	`keyReleased(KeyEvent e)`
`void`	`keyTyped(KeyEvent e)`
`void`	`listUpdated()` Notifies the navigation panel that the list of objects or objects within the list have changed and the view needs to be updated.
`void`	`removeListSelectionListener(ListSelectionListener listener)` Removes a selection changed listener.
`void`	`removeSelectionInterval(int firstIndex, int lastIndex)` Removes a selection for a given range of objects.
`void`	`requestFocusForFirstItem()` Requests the focus for the first object, whether list- or tree-view.
`void`	`scrollToFirstItem()` Scrolls to the first object, whether list- or tree-view.
`void`	`scrollToIndex(int index)` Scrolls to object at given index.
`void`	`setAutoPack(boolean autoPack)` Sets the pack mode.
`void`	`setButtonMode(int buttonMode)` Sets the button mode.
`void`	`setCancelButtonVisible(boolean visible)` Sets the visibility of the cancel button.
`void`	`setCloseButtonVisible(boolean visible)` Sets the visibility of the select button.
`void`	`setDisposeKeyEnabled(boolean enabled)` Sets whether the cancel/dispose-key is enabled. If this key is pressed when tree or table has the focus the enclosing window is disposed.
`void`	`setListSelectionMode(int mode)` Sets the list selection mode.
`void`	`setObjects(List<T> list)` Replaces the current list of objects and updates the view.
`void`	`setObjects(List<T> list, boolean rebuildView)` Replaces the current list of objects and updates the view.
`void`	`setObjects(List<T> list, PdoNavigationPanel.ViewMode viewMode)` Replaces the current list of objects and updates the view.
`void`	`setPopupEnabled(boolean enabled)` Allow/disallow popup-menu in the tree view.
`void`	`setSelectButtonVisible(boolean visible)` Sets the visibility of the select button.
`void`	`setTableIntro(String tableIntro)` Sets the table's intro-text that appears on the first page of the printout, usually the selection criteria from a search parameter.
`void`	`setTableTitle(String tableTitle)` Sets the table's title-text that appears on the printout.
`void`	`setTemplateProvider(T templateProvider)` Sets the optional template provider.
`void`	`setTreeFilter(org.tentackle.misc.ObjectFilter<T> treeFilter)` Sets the tree filter. Optional filter to reduce the root objects visible in the tree view.
`void`	`setTreeSelectionMode(int mode)` Sets the tree selection mode.
`void`	`setup(List<T> list, SelectionFilter selectionFilter, int buttonMode, boolean showTable, String tableName)` setup panel
`void`	`setViewModeButtonsVisible(boolean visible)` Sets the visibility of the tree- and table view buttons.

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
  - SHOW_CANCEL
```
public static final int SHOW_CANCEL
```
    show cancel button
    
    See Also:
    
    Constant Field Values
  - SHOW_SELECT
```
public static final int SHOW_SELECT
```
    show select button
    
    See Also:
    
    Constant Field Values
  - SHOW_CLOSE
```
public static final int SHOW_CLOSE
```
    show close button
    
    See Also:
    
    Constant Field Values
  - SHOW_BUTTONS
```
public static final int SHOW_BUTTONS
```
    show default buttons: cancel and select
    
    See Also:
    
    Constant Field Values
  - SHOW_NOBUTTON
```
public static final int SHOW_NOBUTTON
```
    don't show any button
    
    See Also:
    
    Constant Field Values
  - ACTION_SELECT
```
public static final String ACTION_SELECT
```
    "select" action
    
    See Also:
    
    Constant Field Values
  - ACTION_CANCEL
```
public static final String ACTION_CANCEL
```
    "cancel" action
    
    See Also:
    
    Constant Field Values
  - ACTION_CLOSE
```
public static final String ACTION_CLOSE
```
    "close" action
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PdoNavigationPanel
```
public PdoNavigationPanel(List<T> list,
                          SelectionFilter selectionFilter,
                          int buttonMode,
                          boolean showTable,
                          String tableName)
```
    Creates a navigation panel.
    
    Parameters:
    
    list - the list of objects
    
    selectionFilter - filter selectable objects, null if nothing selectable
    
    buttonMode - the visibility of buttons, one of SHOW_...
    
    showTable - true if initially show the table view, false = tree view
    
    tableName - the preferences tablename, null if preferences by getFormTableName() from 1st object in list
  - PdoNavigationPanel
```
public PdoNavigationPanel(List<T> list,
                          SelectionFilter selectionFilter,
                          int buttonMode,
                          boolean showTable)
```
    Creates a navigation panel.
    The preferences table name is determined by the first object.
    
    Parameters:
    
    list - the list of objects
    
    selectionFilter - filter selectable objects, null if nothing selectable
    
    buttonMode - the visibility of buttons, one of SHOW_...
    
    showTable - true if initially show the table view, false = tree view
  - PdoNavigationPanel
```
public PdoNavigationPanel(List<T> list,
                          SelectionFilter selectionFilter)
```
    Creates a navigation panel.
    The preferences table name is determined by the first object. The default buttons are shown (select and cancel). The initial view mode is tree-view.
    
    Parameters:
    
    list - the list of objects
    
    selectionFilter - filter selectable objects, null if nothing selectable
  - PdoNavigationPanel
```
public PdoNavigationPanel(List<T> list)
```
    Creates a navigation panel.
    The preferences table name is determined by the first object. The default buttons are shown (select and cancel). The initial view mode is tree-view. Nothing to select.
    
    Parameters:
    
    list - the list of objects
  - PdoNavigationPanel
```
public PdoNavigationPanel(T obj,
                          SelectionFilter selectionFilter,
                          int buttonMode,
                          boolean showTable,
                          String tableName)
```
    Creates a navigation panel for a single object.
    
    Parameters:
    
    obj - the database object
    
    selectionFilter - filter selectable objects, null if nothing selectable
    
    buttonMode - the visibility of buttons, one of SHOW_...
    
    showTable - true if initially show the table view, false = tree view
    
    tableName - the preferences tablename, null if preferences object
  - PdoNavigationPanel
```
public PdoNavigationPanel(T obj,
                          SelectionFilter selectionFilter,
                          int buttonMode,
                          boolean showTable)
```
    Creates a navigation panel for a single object.
    The preferences table name is determined by the object.
    
    Parameters:
    
    obj - the database object
    
    selectionFilter - filter selectable objects, null if nothing selectable
    
    buttonMode - the visibility of buttons, one of SHOW_...
    
    showTable - true if initially show the table view, false = tree view
  - PdoNavigationPanel
```
public PdoNavigationPanel(T obj,
                          SelectionFilter selectionFilter)
```
    Creates a navigation panel for a single object.
    The preferences table name is determined by the object. The default buttons are shown (select and cancel). The initial view mode is tree-view.
    
    Parameters:
    
    obj - the database object
    
    selectionFilter - filter selectable objects, null if nothing selectable
  - PdoNavigationPanel
```
public PdoNavigationPanel(T obj)
```
    Creates a navigation panel for a single object.
    The preferences table name is determined by the object. The default buttons are shown (select and cancel). The initial view mode is tree-view. Nothing to select.
    
    Parameters:
    
    obj - the database object
  - PdoNavigationPanel
```
public PdoNavigationPanel()
```
    Creates an empty navigation panel.
    This constructor makes it a bean.
- Method Detail
  - setTableIntro
```
public void setTableIntro(String tableIntro)
```
    Sets the table's intro-text that appears on the first page of the printout, usually the selection criteria from a search parameter. Must be invoked before setObjects().
    
    Parameters:
    
    tableIntro - the table intro text, null if none
  - getTableIntro
```
public String getTableIntro()
```
    Gets the table intro text.
    
    Returns:
    
    the intro text, null if none
  - setTableTitle
```
public void setTableTitle(String tableTitle)
```
    Sets the table's title-text that appears on the printout. Must be invoked before setObjects().
    
    Parameters:
    
    tableTitle - the table title, null if none
  - getTableTitle
```
public String getTableTitle()
```
    Gets the table's title.
    
    Returns:
    
    the title, null if none
  - getTableClass
```
public Class<T> getTableClass()
```
    Gets the class of objects which is shown in the table.
    
    Returns:
    
    the database object class, null if not determined yet
  - getSelectionFilter
```
public SelectionFilter getSelectionFilter()
```
    Gets the selection filter.
    
    Returns:
    
    the selection filter, null if all of PDO class are allowed
  - setTreeFilter
```
public void setTreeFilter(org.tentackle.misc.ObjectFilter<T> treeFilter)
```
    Sets the tree filter.
    Optional filter to reduce the root objects visible in the tree view.
    
    Parameters:
    
    treeFilter - filter for tree, null for none
  - getTreeFilter
```
public org.tentackle.misc.ObjectFilter<T> getTreeFilter()
```
    Gets the tree filter.
    
    Returns:
    
    the tree filter, null if none
  - setPopupEnabled
```
public void setPopupEnabled(boolean enabled)
```
    Allow/disallow popup-menu in the tree view.
    
    Parameters:
    
    enabled - true if allow popup menu (default)
  - isPopupEnabled
```
public boolean isPopupEnabled()
```
    Returns whether popup menu is allowed in the tree view.
    
    Returns:
    
    true if allowed (default)
  - setViewModeButtonsVisible
```
public void setViewModeButtonsVisible(boolean visible)
```
    Sets the visibility of the tree- and table view buttons.
    The default is visible.
    
    Parameters:
    
    visible - true if visible
  - isViewModeButtonsVisible
```
public boolean isViewModeButtonsVisible()
```
    Gets the visibility of the tree- and table view buttons.
    
    Returns:
    
    true if buttons are visible
  - requestFocusForFirstItem
```
public void requestFocusForFirstItem()
```
    Requests the focus for the first object, whether list- or tree-view.
  - scrollToFirstItem
```
public void scrollToFirstItem()
```
    Scrolls to the first object, whether list- or tree-view.
  - getObjects
```
public List<T> getObjects()
```
    Gets the current list of objects shown.
    
    Returns:
    
    the list of objects
  - setObjects
```
public void setObjects(List<T> list,
                       PdoNavigationPanel.ViewMode viewMode)
```
    Replaces the current list of objects and updates the view.
    
    Parameters:
    
    list - the list of objects
    
    viewMode - is null to keep current view, else the new PdoNavigationPanel.ViewMode to rebuild the view as a tree or table
  - setObjects
```
public void setObjects(List<T> list,
                       boolean rebuildView)
```
    Replaces the current list of objects and updates the view.
    
    Parameters:
    
    list - the list of objects
    
    rebuildView - is true to rebuild the view, false if keep it
  - setObjects
```
public void setObjects(List<T> list)
```
    Replaces the current list of objects and updates the view.
    
    Parameters:
    
    list - the list of objects
  - getTemplateProvider
```
public T getTemplateProvider()
```
    Returns the optional tempalte provider.
    
    Returns:
    
    The optional tempalte provider
  - setTemplateProvider
```
public void setTemplateProvider(T templateProvider)
```
    Sets the optional template provider.
    
    Parameters:
    
    templateProvider - The optional tempalte provider to set
  - getModelIndex
```
protected int getModelIndex(int viewRow)
```
    Gets the model row if navisorter and/or rowsorter is installed.
    
    Parameters:
    
    viewRow - the table's row
    
    Returns:
    
    the model row
  - getViewIndex
```
protected int getViewIndex(int modelRow)
```
    Gets the view row if navisorter and/or rowsorter is installed.
    
    Parameters:
    
    modelRow - the model's row
    
    Returns:
    
    the table (view) row
  - getViewMode
```
public PdoNavigationPanel.ViewMode getViewMode()
```
    Gets the current viewmode
    
    Returns:
    
    the current view, null if nothing displayed so far
  - isAutoPack
```
public boolean isAutoPack()
```
    Gets the pack mode.
    
    Returns:
    
    true if parent window is packed whenever the view is updated, default is false
  - setAutoPack
```
public void setAutoPack(boolean autoPack)
```
    Sets the pack mode.
    
    Parameters:
    
    autoPack - true to pack the parent window if view is updated, default is false
  - setButtonMode
```
public void setButtonMode(int buttonMode)
```
    Sets the button mode.
    
    Parameters:
    
    buttonMode - sets the buttons (see SHOW_... above)
  - getButtonMode
```
public int getButtonMode()
```
    Gets the button mode.
    
    Returns:
    
    the buttonMode (see SHOW_... above)
  - setCancelButtonVisible
```
public void setCancelButtonVisible(boolean visible)
```
    Sets the visibility of the cancel button.
    
    Parameters:
    
    visible - is true if visible, false if not
  - isCancelButtonVisible
```
public boolean isCancelButtonVisible()
```
    Gets the visibility of the cancel button.
    
    Returns:
    
    true if visible, false if not
  - setSelectButtonVisible
```
public void setSelectButtonVisible(boolean visible)
```
    Sets the visibility of the select button.
    
    Parameters:
    
    visible - is true if visible, false if not
  - isSelectButtonVisible
```
public boolean isSelectButtonVisible()
```
    Gets the visibility of the select button.
    
    Returns:
    
    true if visible, false if not
  - setCloseButtonVisible
```
public void setCloseButtonVisible(boolean visible)
```
    Sets the visibility of the select button.
    
    Parameters:
    
    visible - is true if visible, false if not
  - isCloseButtonVisible
```
public boolean isCloseButtonVisible()
```
    Gets the visibility of the select button.
    
    Returns:
    
    true if visible, false if not
  - createTable
```
public FormTable<T> createTable()
```
    Creates the navigation table.
    
    Returns:
    
    the table
  - createTree
```
public PdoTree createTree()
```
    Creates the navigation tree.
    
    Returns:
    
    the tree
  - setup
```
public void setup(List<T> list,
                  SelectionFilter selectionFilter,
                  int buttonMode,
                  boolean showTable,
                  String tableName)
```
    setup panel
    
    Parameters:
    
    list - is the initial list of objects to be shown
    
    selectionFilter - are the classes allowed to be selected
    
    buttonMode - tells what buttons are visible/invisible (one of SHOW_...)
    
    showTable - is true if initially show the table view, false = tree view
    
    tableName - is != null if preferences not by getFormTableName() from 1st object in list
  - getCancelButton
```
public FormButton getCancelButton()
```
    Gives access to cancel button (to modify the text, i.e.)
    
    Returns:
    
    the cancel button
  - getSelectButton
```
public FormButton getSelectButton()
```
    Gives access to select button (to modify the text, i.e.)
    
    Returns:
    
    the select button
  - setListSelectionMode
```
public void setListSelectionMode(int mode)
```
    Sets the list selection mode. The tree selection mode is updated accordingly.
    
    Parameters:
    
    mode - the list selection mode from ListSelectionModel
    
    See Also:
    
    ListSelectionModel, TreeSelectionModel
  - setTreeSelectionMode
```
public void setTreeSelectionMode(int mode)
```
    Sets the tree selection mode. The list selection mode is updated accordingly.
    
    Parameters:
    
    mode - the list selection mode from TreeSelectionModel
    
    See Also:
    
    ListSelectionModel, TreeSelectionModel
  - getNaviTree
```
public PdoTree getNaviTree()
```
    Gives access to the navigation tree.
    
    Returns:
    
    the tree, null if not yet created
  - getNaviTable
```
public FormTable<T> getNaviTable()
```
    Gives access to the table list.
    
    Returns:
    
    the table, null if not yet created
  - clearSelection
```
public void clearSelection()
```
    Clears the selections.
  - listUpdated
```
public void listUpdated()
```
    Notifies the navigation panel that the list of objects or objects within the list have changed and the view needs to be updated.
  - addSelectionInterval
```
public void addSelectionInterval(int firstIndex,
                                 int lastIndex)
```
    Adds a selection for a given range of objects.
    
    Parameters:
    
    firstIndex - the index of the first object in the current list of objects
    
    lastIndex - the index of the last object in the current list of objects
  - removeSelectionInterval
```
public void removeSelectionInterval(int firstIndex,
                                    int lastIndex)
```
    Removes a selection for a given range of objects.
    
    Parameters:
    
    firstIndex - the index of the first object in the current list of objects
    
    lastIndex - the index of the last object in the current list of objects
  - scrollToIndex
```
public void scrollToIndex(int index)
```
    Scrolls to object at given index.
    
    Parameters:
    
    index - the index of the object in the current list of objects
  - setDisposeKeyEnabled
```
public void setDisposeKeyEnabled(boolean enabled)
```
    Sets whether the cancel/dispose-key is enabled.
    If this key is pressed when tree or table has the focus the enclosing window is disposed.
    
    Parameters:
    
    enabled - true to enable, false to disable
  - isDisposeKeyEnabled
```
public boolean isDisposeKeyEnabled()
```
    Returns whether the dispose key is enabled.
    
    Returns:
    
    true if enabled
  - addListSelectionListener
```
public void addListSelectionListener(ListSelectionListener listener)
```
    Adds a selection changed listener.
    
    Parameters:
    
    listener - the listener to add
  - removeListSelectionListener
```
public void removeListSelectionListener(ListSelectionListener listener)
```
    Removes a selection changed listener.
    
    Parameters:
    
    listener - the listener to remove
  - getSelectedObject
```
public PersistentDomainObject<?> getSelectedObject()
```
    Gets the selected object. If there are more than one object in the current list of selections, the object "clicked last" is returned.
    
    Returns:
    
    the object, null if nothing selected
  - getSelectedObjects
```
public List<PersistentDomainObject<?>> getSelectedObjects()
```
    Gets all selected objects.
    
    Returns:
    
    the list of selected objects, null if nothing selected
  - isObjectEditedModal
```
protected boolean isObjectEditedModal()
```
    Determines whether the object should be edited modal or non-modal.
    The default implementation returns true if the parent window is modal.
    
    Returns:
    
    true if modal
  - editObjectInTable
```
protected void editObjectInTable(boolean changeable)
```
    Edits the object currently selected in table.
    
    Parameters:
    
    changeable - true if edit, false if show only
  - createFormTableModel
```
public FormTableModel<T> createFormTableModel(FormTableEntry<T> template)
```
    Creates the formtable model for a given object.
    The default implementation just creates the model and binds it.
    
    Parameters:
    
    template - the formtable entry
    
    Returns:
    
    the table model
  - keyTyped
```
public void keyTyped(KeyEvent e)
```
    Specified by:
    
    keyTyped in interface KeyListener
  - keyPressed
```
public void keyPressed(KeyEvent e)
```
    Specified by:
    
    keyPressed in interface KeyListener
  - keyReleased
```
public void keyReleased(KeyEvent e)
```
    Specified by:
    
    keyReleased in interface KeyListener

Class PdoNavigationPanel<T extends PersistentDomainObject<T>>

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class org.tentackle.swing.FormPanel

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

SHOW_CANCEL

SHOW_SELECT

SHOW_CLOSE

SHOW_BUTTONS

SHOW_NOBUTTON

ACTION_SELECT

ACTION_CANCEL

ACTION_CLOSE

Constructor Detail

PdoNavigationPanel

PdoNavigationPanel

PdoNavigationPanel

PdoNavigationPanel

PdoNavigationPanel

PdoNavigationPanel

PdoNavigationPanel

PdoNavigationPanel

PdoNavigationPanel

Method Detail

setTableIntro

getTableIntro

setTableTitle

getTableTitle

getTableClass

getSelectionFilter

setTreeFilter

getTreeFilter

setPopupEnabled

isPopupEnabled

setViewModeButtonsVisible

isViewModeButtonsVisible

requestFocusForFirstItem

scrollToFirstItem

getObjects

setObjects

setObjects

setObjects

getTemplateProvider

setTemplateProvider

getModelIndex

getViewIndex

getViewMode

isAutoPack

setAutoPack

setButtonMode

getButtonMode

setCancelButtonVisible

isCancelButtonVisible

setSelectButtonVisible

isSelectButtonVisible

setCloseButtonVisible

isCloseButtonVisible

createTable

createTree

setup

getCancelButton

getSelectButton

setListSelectionMode

setTreeSelectionMode

getNaviTree

getNaviTable