|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--javax.swing.JPanel | +--com.ibm.mm.beans.gui.CMBFolderViewer
The CMBFolderViewer bean displays a panel which provides a Windows Explorer-style presentation of folders and their contents, with a tree view of the folders in a pane on the left, and a notebook of tables with details of documents within the selected folder in a pane on the right. The two panes are separated by a resizable splitter.
Tree Pane
The tree pane contains a main folder for each folder being viewed. Beneath each of these folders are folders for each nested folder (if any).
Details Pane
The details pane contains a notebook, with a table for each index class/server the items are indexed under. The tab has the name:
Popup Menus
When a right click is performed on a column heading, a popup menu appears with the following selections:
When a right click is performed on a folder or document, a popup menu appears with the following selections:
Double-Click Action
The double-click action on a folder in the tree pane or item in the details pane will cause the same action as the "View" menu item. If the popup menu for items is being suppressed, a CMBItemActionEvent will be generated.
Inner classes inherited from class javax.swing.JPanel |
javax.swing.JPanel.AccessibleJPanel |
Inner classes inherited from class javax.swing.JComponent |
javax.swing.JComponent.AccessibleJComponent |
Inner classes inherited from class java.awt.Container |
java.awt.Container.AccessibleAWTContainer |
Inner classes inherited from class java.awt.Component |
java.awt.Component.AccessibleAWTComponent |
Field Summary | |
static int |
SORT_ASCENDING
Used as an argument to the sort() method. |
static int |
SORT_DESCENDING
Used as an argument to the sort() method. |
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 com.ibm.mm.beans.gui.CMBViewFolderListener |
copyright |
Fields inherited from interface java.awt.image.ImageObserver |
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
Constructor Summary | |
CMBFolderViewer()
|
Method Summary | |
void |
addEditItemAttributesListener(CMBEditItemAttributesListener listener)
Adds the specified listener to receive Edit Item Attributes events. |
void |
addFolderActionListener(CMBFolderActionListener listener)
Adds the specified listener to receive Folder Action events. |
void |
addFolderPopupListener(CMBFolderPopupListener listener)
Adds the specified listener to receive Folder Popup events. |
void |
addFolderSelectedListener(CMBFolderSelectedListener listener)
Adds the specified listener to receive Folder Selected events. |
void |
addHelpListener(CMBHelpListener listener)
Adds the specified listener to receive Help events. |
void |
addItemActionListener(CMBItemActionListener listener)
Adds the specified listener to receive Item Action events. |
void |
addItemPopupListener(CMBItemPopupListener listener)
Adds the specified listener to receive Item Popup events. |
void |
addItemSelectedListener(CMBItemSelectedListener listener)
Adds the specified listener to receive Item Selected events. |
void |
addViewDocumentListener(CMBViewDocumentListener listener)
Adds the specified listener to receive View Document events. |
void |
addViewVersionsListener(CMBViewVersionsListener listener)
Adds the specified listener to receive View Versions events. |
int |
getCollationStrength()
Gets the collation strength, which determines the exactness of comparisons when sorting items in the table |
CMBConnection |
getConnection()
Gets the CMBConnection bean associated with this folder viewer. |
CMBItem[] |
getFolders()
Gets the CMBItem objects representing the folders being displayed. |
java.awt.Color |
getLineContrastColor()
Gets the line contrast Color property. |
CMBItem |
getSelectedFolder()
Gets the CMBItem object representing the folder selected in the tree pane. |
CMBItem |
getSelectedItem()
Gets the selected item in the details pane (single-select) or the first selected item (multi-select). |
CMBItem[] |
getSelectedItems()
Gets the selected items in the details pane. |
int |
getTreePaneWidth()
Gets the width of the tree pane. |
boolean |
isDefaultPopupEnabled()
Determines if the default popup menu will appear when the user clicks on items in the details pane. |
boolean |
isDetailsHorizontalLinesVisible()
Determines if horizontal lines are showing between items in the details pane. |
boolean |
isDetailsVerticalLinesVisible()
Determines if vertical lines are showing between columns in the details pane. |
boolean |
isMultiSelectEnabled()
Determines if multiple selection of items in the details pane is allowed. |
boolean |
isTableLineContrast()
Gets the value of line contrast property. |
void |
onViewFolder(CMBViewFolderEvent event)
Implementation of CMBViewFolderListener, to simplify connecting to the CMBSearchResultsViewer bean. |
void |
refresh()
Restores template display fields to sizes/position as specified in the search template. |
void |
removeEditItemAttributesListener(CMBEditItemAttributesListener listener)
Removes the specified listener so that it no longer receives Edit Item Attributes events. |
void |
removeFolderActionListener(CMBFolderActionListener listener)
Removes the specified listener so that it no longer receives Folder Action events. |
void |
removeFolderPopupListener(CMBFolderPopupListener listener)
Removes the specified listener so that it no longer receives Folder Popup events. |
void |
removeFolderSelectedListener(CMBFolderSelectedListener listener)
Removes the specified listener so that it no longer receives Folder Selected events. |
void |
removeHelpListener(CMBHelpListener listener)
Removes the specified listener so that it no longer receives Help events. |
void |
removeItemActionListener(CMBItemActionListener listener)
Removes the specified listener so that it no longer receives Item Action events. |
void |
removeItemPopupListener(CMBItemPopupListener listener)
Removes the specified listener so that it no longer receives I tem Popup events. |
void |
removeItemSelectedListener(CMBItemSelectedListener listener)
Removes the specified listener so that it no longer receives Item Selected events. |
void |
removeViewDocumentListener(CMBViewDocumentListener listener)
Removes the specified listener so that it no longer receives View Document events. |
void |
removeViewVersionsListener(CMBViewVersionsListener listener)
Removes the specified listener so that it no longer receives View Versions events. |
void |
restoreConfiguration(java.util.Properties properties)
Restores the column sizes and ordering by template, as well as the size of the tree pane. |
void |
saveConfiguration(java.util.Properties properties)
Saves the column sizes and ordering by template, as well as the size of the tree pane. |
void |
setBackground(java.awt.Color newColor)
Overridden to set background of contained controls |
void |
setCollationStrength(int newStrength)
Sets the collation strength, which determines the exactness of comparisons when sorting items in the table |
void |
setConnection(CMBConnection newConnection)
Sets the CMBConnection bean associated with this folder viewer. |
void |
setCursor(java.awt.Cursor newCursor)
Overridden to set cursor of contained controls |
void |
setDefaultPopupEnabled(boolean newValue)
Sets if the default popup menu will appear when the user clicks on items in the details pane. |
void |
setDetailsHorizontalLinesVisible(boolean newValue)
Sets if horizontal lines are shown between items in the details pane. |
void |
setDetailsVerticalLinesVisible(boolean newValue)
Sets if vertical lines are shown between columns in the details pane. |
void |
setEnabled(boolean newEnable)
Overridden to disable contained controls |
void |
setFolders(CMBItem[] newFolders)
Sets the folders being displayed. |
void |
setFont(java.awt.Font newFont)
Overridden to set font of contained controls |
void |
setForeground(java.awt.Color newColor)
Overridden to set foreground of contained controls |
void |
setLineContrastColor(java.awt.Color newColor)
Sets the line contrast Color property. |
void |
setMultiSelectEnabled(boolean newValue)
Sets if multiple selection of items in the details pane is allowed. |
void |
setOpaque(boolean newOpaque)
Overridden to set opaque on contained controls |
void |
setSelectedFolder(CMBItem newFolder)
Sets the folder selected in the tree pane. |
void |
setSelectedItem(CMBItem newItem)
Set the selected item in the details pane. |
void |
setSelectedItems(CMBItem[] newItems)
Sets the selected items in the details pane. |
void |
setTableLineContrast(boolean newVal)
Sets the value of line contrast property. |
void |
setToolTipText(java.lang.String newTooltip)
Overridden to set tooltip text on contained controls |
void |
setTreePaneWidth(int newWidth)
Sets the width of the tree pane. |
void |
sort(java.lang.String field,
int order)
Sorts the list in the details pane by a field in ascending or descending order. |
Methods inherited from class javax.swing.JPanel |
getAccessibleContext, getUIClassID, paramString, updateUI |
Methods inherited from class javax.swing.JComponent |
addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setPreferredSize, setRequestFocusEnabled, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update |
Methods inherited from class java.awt.Container |
add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree |
Methods inherited from class java.awt.Component |
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int SORT_ASCENDING
public static final int SORT_DESCENDING
Constructor Detail |
public CMBFolderViewer()
Method Detail |
public boolean isTableLineContrast()
public void setTableLineContrast(boolean newVal)
public java.awt.Color getLineContrastColor()
public void setLineContrastColor(java.awt.Color newColor)
public int getTreePaneWidth()
public void setTreePaneWidth(int newWidth)
public CMBConnection getConnection()
public void setConnection(CMBConnection newConnection)
public CMBItem[] getFolders()
public void setFolders(CMBItem[] newFolders)
newFolders
- the CMBItem objects representing the folders
to display.public void onViewFolder(CMBViewFolderEvent event)
onViewFolder
in interface CMBViewFolderListener
public CMBItem getSelectedFolder()
public void setSelectedFolder(CMBItem newFolder)
newFolder
- the CMBItem object for the folder to select.
If this is not a folder within the selection results,
the selection is not changed.public CMBItem getSelectedItem()
public void setSelectedItem(CMBItem newItem)
newItem
- the CMBItem object for the item to select.
If this is not an item in the currently
displayed table, the selection is not
changed. An item of null will deselect any
selected item(s).public CMBItem[] getSelectedItems()
public void setSelectedItems(CMBItem[] newItems)
newItems
- the CMBItem objects for the items to
select. If an item or items are not in
the currently displayed table, the
selection is cleared.public int getCollationStrength()
public void setCollationStrength(int newStrength)
public boolean isDetailsHorizontalLinesVisible()
public void setDetailsHorizontalLinesVisible(boolean newValue)
public boolean isDetailsVerticalLinesVisible()
public void setDetailsVerticalLinesVisible(boolean newValue)
public boolean isMultiSelectEnabled()
public void setMultiSelectEnabled(boolean newValue)
public boolean isDefaultPopupEnabled()
public void setDefaultPopupEnabled(boolean newValue)
public void refresh()
public void sort(java.lang.String field, int order)
field
- the name of a column. This must the name of one
of the columns currently displayed in the details pane.order
- the order of the sort. Must be either SORT_ASCENDING
or SORT_DESCENDING.public void saveConfiguration(java.util.Properties properties)
public void restoreConfiguration(java.util.Properties properties)
public void addFolderSelectedListener(CMBFolderSelectedListener listener)
public void removeFolderSelectedListener(CMBFolderSelectedListener listener)
public void addFolderPopupListener(CMBFolderPopupListener listener)
public void removeFolderPopupListener(CMBFolderPopupListener listener)
public void addFolderActionListener(CMBFolderActionListener listener)
public void removeFolderActionListener(CMBFolderActionListener listener)
public void addItemSelectedListener(CMBItemSelectedListener listener)
public void removeItemSelectedListener(CMBItemSelectedListener listener)
public void addItemPopupListener(CMBItemPopupListener listener)
public void removeItemPopupListener(CMBItemPopupListener listener)
public void addItemActionListener(CMBItemActionListener listener)
public void removeItemActionListener(CMBItemActionListener listener)
public void addViewDocumentListener(CMBViewDocumentListener listener)
public void removeViewDocumentListener(CMBViewDocumentListener listener)
public void addViewVersionsListener(CMBViewVersionsListener listener)
public void removeViewVersionsListener(CMBViewVersionsListener listener)
public void addEditItemAttributesListener(CMBEditItemAttributesListener listener)
public void removeEditItemAttributesListener(CMBEditItemAttributesListener listener)
public void addHelpListener(CMBHelpListener listener)
public void removeHelpListener(CMBHelpListener listener)
public void setForeground(java.awt.Color newColor)
setForeground
in class javax.swing.JComponent
public void setBackground(java.awt.Color newColor)
setBackground
in class javax.swing.JComponent
public void setFont(java.awt.Font newFont)
setFont
in class javax.swing.JComponent
public void setCursor(java.awt.Cursor newCursor)
setCursor
in class java.awt.Component
public void setOpaque(boolean newOpaque)
setOpaque
in class javax.swing.JComponent
public void setToolTipText(java.lang.String newTooltip)
setToolTipText
in class javax.swing.JComponent
public void setEnabled(boolean newEnable)
setEnabled
in class javax.swing.JComponent
|
EIP JavaBeans | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |