org.pdfsam.guiclient.commons.panels
Class JPdfSelectionPanel

java.lang.Object
  extended by java.awt.Component
      extended by java.awt.Container
          extended by javax.swing.JComponent
              extended by javax.swing.JPanel
                  extended by org.pdfsam.guiclient.commons.panels.JPdfSelectionPanel
All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class JPdfSelectionPanel
extends javax.swing.JPanel

Customizable Panel for the selection of pdf documents

Author:
Andrea Vacondio
See Also:
Serialized Form

Nested Class Summary
 
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 int DOUBLE_SELECTABLE_FILE
           
static java.lang.String OUTPUT_PATH_PROPERTY
           
static int SINGLE_SELECTABLE_FILE
           
static int UNLIMTED_SELECTABLE_FILE_NUMBER
           
 
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
JPdfSelectionPanel()
          default constructor shows every button and permits an unlimited number of selected input documents
JPdfSelectionPanel(int maxSelectableFiles, int showedColums)
          showEveryButton is true if maxSelectableFiles is > 1
JPdfSelectionPanel(int maxSelectableFiles, int showedColums, boolean showEveryButton)
           
JPdfSelectionPanel(int maxSelectableFiles, int showedColums, boolean showRemoveButton, boolean showMoveButtons)
           
 
Method Summary
 void addPopupMenuAction(javax.swing.AbstractAction action)
           
 void addTableRow(PdfSelectionTableItem item)
          adds a item to the table
 void addWipText(java.lang.String wipText)
          add a text to say the user we are working
 void clearSelectionTable()
          Clear the selection table
 javax.swing.JButton getAddFileButton()
           
 javax.swing.JButton getClearButton()
           
 PdfLoader getLoader()
           
 JPdfSelectionTable getMainTable()
           
 int getMaxSelectableFiles()
           
 javax.swing.JButton getMoveDownButton()
           
 javax.swing.JButton getMoveUpButton()
           
 javax.swing.JButton getRemoveFileButton()
           
 java.awt.dnd.DropTarget getScrollPanelDropTarget()
           
 java.awt.dnd.DropTarget getTableDropTarget()
           
 PdfSelectionTableItem[] getTableRows()
           
 boolean isAdding()
           
 boolean isSetOutputPathMenuItemEnabled()
           
 boolean isShowEveryButton()
           
 boolean isSingleSelectableFile()
           
 void removeWipText(java.lang.String wipText)
          remove the text to say the user we are working
 void removeWipTextAll()
          removes every element from the list
 void setFullAccessRequired(boolean required)
          If true, the selection table default renderer will show a tooltip message when the document is not opened with full permissions
 void updateTableRow(int index, PdfSelectionTableItem item)
          update an item to the table
 
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, 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, 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, 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

UNLIMTED_SELECTABLE_FILE_NUMBER

public static final int UNLIMTED_SELECTABLE_FILE_NUMBER
See Also:
Constant Field Values

SINGLE_SELECTABLE_FILE

public static final int SINGLE_SELECTABLE_FILE
See Also:
Constant Field Values

DOUBLE_SELECTABLE_FILE

public static final int DOUBLE_SELECTABLE_FILE
See Also:
Constant Field Values

OUTPUT_PATH_PROPERTY

public static final java.lang.String OUTPUT_PATH_PROPERTY
See Also:
Constant Field Values
Constructor Detail

JPdfSelectionPanel

public JPdfSelectionPanel()
default constructor shows every button and permits an unlimited number of selected input documents


JPdfSelectionPanel

public JPdfSelectionPanel(int maxSelectableFiles,
                          int showedColums)
showEveryButton is true if maxSelectableFiles is > 1

Parameters:
maxSelectableFiles -
showedColums -

JPdfSelectionPanel

public JPdfSelectionPanel(int maxSelectableFiles,
                          int showedColums,
                          boolean showEveryButton)
Parameters:
maxSelectableFiles -
showedColums -
showEveryButton - if true shows every button, if false hide remove button and move buttons

JPdfSelectionPanel

public JPdfSelectionPanel(int maxSelectableFiles,
                          int showedColums,
                          boolean showRemoveButton,
                          boolean showMoveButtons)
Parameters:
maxSelectableFiles -
showedColums -
showRemoveButton - if true shows the remove button
showMoveButtons - if true shows the move buttons
Method Detail

isShowEveryButton

public boolean isShowEveryButton()
Returns:
the showEveryButton

getMaxSelectableFiles

public int getMaxSelectableFiles()
Returns:
the maxSelectableFiles

getMainTable

public JPdfSelectionTable getMainTable()
Returns:
the mainTable

addWipText

public void addWipText(java.lang.String wipText)
add a text to say the user we are working


removeWipText

public void removeWipText(java.lang.String wipText)
remove the text to say the user we are working


removeWipTextAll

public void removeWipTextAll()
removes every element from the list


isAdding

public boolean isAdding()
Returns:
true if some thread is loading a pdf document

addTableRow

public void addTableRow(PdfSelectionTableItem item)
adds a item to the table

Parameters:
item -

updateTableRow

public void updateTableRow(int index,
                           PdfSelectionTableItem item)
update an item to the table

Parameters:
index -
item -

getTableRows

public PdfSelectionTableItem[] getTableRows()
Returns:
rows of the model

getLoader

public PdfLoader getLoader()
Returns:
the pdf loader

getAddFileButton

public javax.swing.JButton getAddFileButton()
Returns:
the addFileButton

getRemoveFileButton

public javax.swing.JButton getRemoveFileButton()
Returns:
the removeFileButton

getMoveUpButton

public javax.swing.JButton getMoveUpButton()
Returns:
the moveUpButton

getMoveDownButton

public javax.swing.JButton getMoveDownButton()
Returns:
the moveDownButton

getClearButton

public javax.swing.JButton getClearButton()
Returns:
the clearButton

getTableDropTarget

public java.awt.dnd.DropTarget getTableDropTarget()
Returns:
the tableDropTarget

getScrollPanelDropTarget

public java.awt.dnd.DropTarget getScrollPanelDropTarget()
Returns:
the scrollPanelDropTarget

isSetOutputPathMenuItemEnabled

public boolean isSetOutputPathMenuItemEnabled()
Returns:
the setOutputPathMenuItemEnabled

isSingleSelectableFile

public boolean isSingleSelectableFile()
Returns:
true if it's a single selectable file panel

addPopupMenuAction

public void addPopupMenuAction(javax.swing.AbstractAction action)
Parameters:
action - adds an item to the popup menu for the given action

setFullAccessRequired

public void setFullAccessRequired(boolean required)
If true, the selection table default renderer will show a tooltip message when the document is not opened with full permissions

Parameters:
required -

clearSelectionTable

public void clearSelectionTable()
Clear the selection table