Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.2.0)

E17493-03


oracle.javatools.history
Class HistoryComponent

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 oracle.javatools.history.HistoryComponent

All Implemented Interfaces:
java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class HistoryComponent
extends javax.swing.JPanel

A component used to display (local or remote) history entries.

Since:
10.0.3
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 java.util.Date LIVE_DATE
          Placeholder Date initialized to the maximum value such that it will always appear as the most recent during sorting and which may be treated as a special case by any cell renderers.

 

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
HistoryComponent()
           

 

Method Summary
 void addListSelectionListener(javax.swing.event.ListSelectionListener lsl)
          Add a listener to be notified when the selection changes.
 void addMouseListener(java.awt.event.MouseListener mouseListener)
           
 void dispose()
          Clean up this history component.
 HistoryProperty[] getHiddenProperties()
           
 HistoryModel getModel()
          Get the model that is currently installed into this component.
 HistoryEntry[] getSelection()
          Get an array containing HistoryEntry objects for all currently selected rows in the component.
 java.lang.String getSelectionCopyString()
          Get a string representing the current selection suitable for copying to the clipboard
 HistoryEntry getSingleSelection()
          Get the current single selection.
 HistoryProperty getSortProperty()
          Get the property the history is currently sorted by.
 GenericTable getTable()
          Get the underlying GenericTable being used to display the history.
 void removeListSelectionListener(javax.swing.event.ListSelectionListener lsl)
          Add a listener to be notified when the selection changes.
 void removeMouseListener(java.awt.event.MouseListener mouseListener)
           
 void selectAll()
           
 void selectFirst()
           
 void setEditorMode(boolean editorMode)
          Deprecated. this is an evil hack and is in the process of being removed.
 void setEnabled(boolean isEnabled)
          Set whether this component is enabled.
 void setModel(HistoryModel model)
          Set the model of this component.
 void setSingleSelection(boolean isSingleSelection)
          Set whether the history table allows only single selection, or multiple selection
 void setSingleSelection(HistoryEntry version)
          Set the selection to the specified single history entry.
 void setUseAutoSizeMaximums(boolean useAutoSizeMaximums)
          Sets whether this component should take into account the maximum auto-size values of properties when sizing the table.
 void setUseScrollPane(boolean useScrollPane)
           
 void sortTableByProperty(HistoryProperty property, boolean ascending)
          Sort the history component by the specified property.

 

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

LIVE_DATE

public static final java.util.Date LIVE_DATE
Placeholder Date initialized to the maximum value such that it will always appear as the most recent during sorting and which may be treated as a special case by any cell renderers. The toString method of this object will return an empty String.

Constructor Detail

HistoryComponent

public HistoryComponent()

Method Detail

setUseScrollPane

public void setUseScrollPane(boolean useScrollPane)

addMouseListener

public void addMouseListener(java.awt.event.MouseListener mouseListener)
Overrides:
addMouseListener in class java.awt.Component

removeMouseListener

public void removeMouseListener(java.awt.event.MouseListener mouseListener)
Overrides:
removeMouseListener in class java.awt.Component

getTable

public GenericTable getTable()
Get the underlying GenericTable being used to display the history.
Returns:
the GenericTable instance being used for this HistoryComponent.

getSortProperty

public HistoryProperty getSortProperty()
Get the property the history is currently sorted by.
Returns:
the HistoryProperty this HistoryComponent is currently sorted by, or null if it is not sorted.

sortTableByProperty

public void sortTableByProperty(HistoryProperty property,
                                boolean ascending)
Sort the history component by the specified property.
Parameters:
property - the property to sort by
ascending - whether the sort order is ascending.

addListSelectionListener

public void addListSelectionListener(javax.swing.event.ListSelectionListener lsl)
Add a listener to be notified when the selection changes.
Parameters:
lsl - a listener that will be notified when selection changes in the component.

removeListSelectionListener

public void removeListSelectionListener(javax.swing.event.ListSelectionListener lsl)
Add a listener to be notified when the selection changes.
Parameters:
lsl - a listener previously registered with addListSelectionListener( javax.swing.event.ListSelectionListener )

setSingleSelection

public void setSingleSelection(boolean isSingleSelection)
Set whether the history table allows only single selection, or multiple selection
Parameters:
isSingleSelection - if true, the table only allows single selection. This is the default.

setEnabled

public void setEnabled(boolean isEnabled)
Set whether this component is enabled.
Overrides:
setEnabled in class javax.swing.JComponent
Parameters:
isEnabled - if true, the component is enabled.

getSelectionCopyString

public java.lang.String getSelectionCopyString()
Get a string representing the current selection suitable for copying to the clipboard
Returns:
a string suitable for copying to the clipboard for the current selection.

getModel

public HistoryModel getModel()
Get the model that is currently installed into this component.
Returns:
the currently installed model.

selectAll

public void selectAll()

selectFirst

public void selectFirst()

getHiddenProperties

public HistoryProperty[] getHiddenProperties()

setUseAutoSizeMaximums

public void setUseAutoSizeMaximums(boolean useAutoSizeMaximums)
Sets whether this component should take into account the maximum auto-size values of properties when sizing the table. This method should be called prior to setModel(oracle.javatools.history.HistoryModel).
Parameters:
useAutoSizeMaximums - if true, auto-size maximums are used.

setModel

public void setModel(HistoryModel model)
Set the model of this component.
Parameters:
model - the model to install into this component.

getSingleSelection

public HistoryEntry getSingleSelection()
Get the current single selection.
Returns:
the current single selection. This is the first item in the selection.

setSingleSelection

public void setSingleSelection(HistoryEntry version)
Set the selection to the specified single history entry.
Parameters:
version - a single entry to select

getSelection

public HistoryEntry[] getSelection()
Get an array containing HistoryEntry objects for all currently selected rows in the component.
Returns:
an array of HistoryEntry.

dispose

public void dispose()
Clean up this history component. It's not mandatory to call this on the component, but if you do so, the component will be unusable after this point. It basically sets all internal references to null.

setEditorMode

public void setEditorMode(boolean editorMode)
Deprecated. this is an evil hack and is in the process of being removed.
Set whether this component is being displayed in an editor window. It will change its appearance somewhat in this case.

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.2.0)

E17493-03


Copyright © 1997, 2012, Oracle. All rights reserved.