oracle.dss.util.dimensionList
Class DimensionList

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JList
                          |
                          +--oracle.dss.util.dimensionList.DragList
                                |
                                +--oracle.dss.util.dimensionList.DimensionList

All Implemented Interfaces:

javax.accessibility.Accessible, DimListCellEditorListener, java.util.EventListener, java.awt.image.ImageObserver, javax.swing.event.ListDataListener, javax.swing.event.ListSelectionListener, java.awt.MenuContainer, javax.swing.Scrollable, java.io.Serializable

public class DimensionList

extends DragList

implements DimListCellEditorListener, javax.swing.event.ListDataListener, javax.swing.event.ListSelectionListener, java.io.Serializable

Displays dimension members in a list. Because this object extends DragList, which extends JList, this object must be displayed in a container. This dimension list bean is used internally by DimensionListPanel.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Field Summary

static int	DRILLSTATE_DRILLABLE The dimension list can be drilled down to show children.
static int	DRILLSTATE_IS_DRILLED The dimension list is drilled down and you can drill up to hide its children.
static int	DRILLSTATE_NOT_DRILLABLE The dimension list cannot be drilled.

Fields inherited from class javax.swing.JComponent

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

DimensionList()
Constructor.

Method Summary

void	addDimensionListListener(DimensionListListener l) Adds a DimensionListListener to this object.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l)
void	clearSelection()
boolean	doCollapseAll() Fully collapses the dimension list to the highest hierarchical level.
boolean	doDrill(int index) Drills a specified member in the model.
boolean	doEdit(int index) Edits the specified item.
boolean	doExpandAll() Fully expands the dimension list to the lowest hierarchical level.
void	doGoBottom() Selects the last member in the list and adjusts the view to make the member visible on the screen if it is not already visible.
void	doGoTop() Selects the first member in the list and adjusts the view to make the member visible on the screen if it is not already visible.
void	doLineDown() Selects the next member in the list below the currently selected member and adjusts the view to make the member visible on the screen if it is not already visible.
void	doLineUp() Selects the member above the currently selected member in the list and adjusts the view to make the member visible on the screen if it is not already visible.
void	doPageDown() Responds to the Page Down key.
void	doPageUp() Responds to the Page Up key.
DimListCellEditor	getCellEditor() Retrieves the current cell editor in use.
int	getCellHeightPadValue() Retrieves the extra height that is added to a cell when the default height of the cell makes the list look crowded.
javax.swing.Icon	getClosedIcon() Retrieves an icon that indicates that a member is not showing its children in the list.
javax.swing.Icon	getCollapsedIcon() Retrieves an icon that indicates that a member is collapsed.
int	getCount() Retrieves the total number of members in the model.
boolean	getEditable() Retrieves the value that indicates whether you can edit members.
int	getEditIndex() Retrieves the index of the member that is being edited.
long	getEndIndex() Retrieves the index of the position in which the dragged member was dropped, in the model.
javax.swing.Icon	getExpandedIcon() Retrieves the icon that indicates that a member is expanded.
int	getFirstVisibleIndex() Retrieves the index of the first visible member on the screen.
javax.swing.Icon	getNodeIcon() Retrieves the icon that indicates that a member is at the lowest hierarchical level.
javax.swing.Icon	getOpenedIcon() Retrieves an icon that indicates that a member is showing its children in the list.
long	getStartIndex() Retrieves the index of the member that is being dragged.
int	getTabPosition() Retrieves the position at which members are left-aligned.
boolean	isContextIconVisible() Indicates whether the Opened and Closed icons are displayed for members in the list.
boolean	isIconVisible() Indicates whether icons are displayed for collapsed and expanded members in the list.
boolean	isToolTipsEnabled() Indicates whether tooltips are displayed when the mouse is over a tool.
void	removeDimensionListListener(DimensionListListener l) Removes a DimensionListListener from this object.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Removes a PropertyChangeListener from this object.
void	setCellEditor(DimListCellEditor anEditor) Specifies the current cell editor.
void	setCellHeightPadValue(int value) Specifies the extra height to add to a cell when the default height of the cell makes the list look crowded.
void	setClosedIcon(javax.swing.Icon icon) Specifies an icon to indicate that a member is not showing its children in the list.
void	setCollapsedIcon(javax.swing.Icon icon) Specifies an icon to indicate that a member is collapsed.
void	setContextIconVisible(boolean visible) Specifies whether the Opened and Closed icons are displayed with the members in a list.
void	setEditable(boolean flag) Specifies whether you can edit members.
void	setEditIndex(int index) Specifies the index of the member that is being edited.
void	setExpandedIcon(javax.swing.Icon icon) Specifies the icon to indicate that a member has been expanded.
void	setFirstVisibleIndex(int index) Specifies the index of the first visible member on the screen.
void	setIconVisible(boolean visible) Specifies whether to display icons for collapsed and expanded members in the list.
void	setModel(DimListDataModel model) Specifies the data model for this dimension list.
void	setNodeIcon(javax.swing.Icon icon) Specifies the icon that indicates that a member is at the lowest hierarchical level.
void	setOpenedIcon(javax.swing.Icon icon) Specifies the icon that indicates that a member is showing its children in the list.
void	setTabPosition(int position) Specifies the position at which you want members to be left-aligned.
void	setToolTipsEnabled(boolean flag) Specifies whether tooltips are displayed when the mouse is over a tool.

Methods inherited from class oracle.dss.util.dimensionList.DragList

isDragEnabled, paint, setDragEnabled

Methods inherited from class javax.swing.JList

addListSelectionListener, addSelectionInterval, ensureIndexIsVisible, getAccessibleContext, getAnchorSelectionIndex, getCellBounds, getCellRenderer, getFixedCellHeight, getFixedCellWidth, getLastVisibleIndex, getLeadSelectionIndex, getMaxSelectionIndex, getMinSelectionIndex, getModel, getPreferredScrollableViewportSize, getPrototypeCellValue, getScrollableBlockIncrement, getScrollableTracksViewportHeight, getScrollableTracksViewportWidth, getScrollableUnitIncrement, getSelectedIndex, getSelectedIndices, getSelectedValue, getSelectedValues, getSelectionBackground, getSelectionForeground, getSelectionMode, getSelectionModel, getUI, getUIClassID, getValueIsAdjusting, getVisibleRowCount, indexToLocation, isSelectedIndex, isSelectionEmpty, locationToIndex, removeListSelectionListener, removeSelectionInterval, setCellRenderer, setFixedCellHeight, setFixedCellWidth, setListData, setListData, setModel, setPrototypeCellValue, setSelectedIndex, setSelectedIndices, setSelectedValue, setSelectionBackground, setSelectionForeground, setSelectionInterval, setSelectionMode, setSelectionModel, setUI, setValueIsAdjusting, setVisibleRowCount, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, 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, paintImmediately, paintImmediately, print, printAll, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setEnabled, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, remove, remove, removeAll, removeContainerListener, setLayout, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, contains, createImage, createImage, dispatchEvent, enable, 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, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.dss.util.dimensionList.DimListCellEditorListener

DimListCellEditorAction

Methods inherited from interface javax.swing.event.ListDataListener

contentsChanged, intervalAdded, intervalRemoved

Methods inherited from interface javax.swing.event.ListSelectionListener

valueChanged

Field Detail

DRILLSTATE_NOT_DRILLABLE

public static final int DRILLSTATE_NOT_DRILLABLE

The dimension list cannot be drilled.

DRILLSTATE_DRILLABLE

public static final int DRILLSTATE_DRILLABLE

The dimension list can be drilled down to show children.

DRILLSTATE_IS_DRILLED

public static final int DRILLSTATE_IS_DRILLED

The dimension list is drilled down and you can drill up to hide its children.

Constructor Detail

DimensionList

public DimensionList()

Constructor.

Method Detail

addDimensionListListener

public void addDimensionListListener(DimensionListListener l)

Adds a DimensionListListener to this object. Use a DimensionListListener to listen for changes in the dimension list.

Parameters:

l - The DimensionListListener that you want to add.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Overrides:

addPropertyChangeListener in class javax.swing.JComponent

clearSelection

public void clearSelection()

Overrides:

clearSelection in class javax.swing.JList

doExpandAll

public boolean doExpandAll()

Fully expands the dimension list to the lowest hierarchical level.

Returns:

true if the list was fully expanded, false if the list was not fully expanded.

doCollapseAll

public boolean doCollapseAll()

Fully collapses the dimension list to the highest hierarchical level.

Returns:

true if the list was fully collapsed, false if the list was not fully collapsed.

doDrill

public boolean doDrill(int index)

Drills a specified member in the model. If the member is collapsed, then this method expands it. If the member is expanded, then this method collapses it.

Parameters:

index - The index of the member that you want to drill. The index indicates the position of the member in the model.

Returns:

true if the drill was successful, false if the drill was unsuccessful.

doEdit

public boolean doEdit(int index)

Edits the specified item.

Parameters:

index - The index of the item that you want to edit. The index indicates the position of the item in the model.

Returns:

true if the item is being edited, false otherwise.

doGoBottom

public void doGoBottom()

Selects the last member in the list and adjusts the view to make the member visible on the screen if it is not already visible.

doGoTop

public void doGoTop()

Selects the first member in the list and adjusts the view to make the member visible on the screen if it is not already visible.

doLineDown

public void doLineDown()

Selects the next member in the list below the currently selected member and adjusts the view to make the member visible on the screen if it is not already visible.

doLineUp

public void doLineUp()

Selects the member above the currently selected member in the list and adjusts the view to make the member visible on the screen if it is not already visible.

doPageDown

public void doPageDown()

Responds to the Page Down key. The first time that you press the Page Down key, the last member on the screen is selected. The next time that you press the Page Down key, the next screen of members is displayed and the last member on the screen is selected.

doPageUp

public void doPageUp()

Responds to the Page Up key. The first time that you press the Page Up key, the first member on the screen is selected. The next time that you press the Page Up key, the previous screen of members is displayed and the first member on the screen is selected.

getCellEditor

public DimListCellEditor getCellEditor()

Retrieves the current cell editor in use.

Returns:

The current CellEditor object in use.

getTabPosition

public int getTabPosition()

Retrieves the position at which members are left-aligned. Application developers should only use tab positions when prefixes are displayed.

Use tab positions to left-align members at a specified position to prevent them from being overlapped by prefix text. If members are preceded by data icons or node icons, then use the tab position to left-align the icons instead of the members. Tab position is measured in pixels.

When there is no prefix preceding a member, then the return value of this method should be zero.

Returns:

The position at which members are left-aligned, in pixels.

setTabPosition

public void setTabPosition(int position)

Specifies the position at which you want members to be left-aligned. Application developers should only use tab positions when prefixes are displayed.

Use tab positions to left-align members at a specified position to prevent them from being overlapped by prefix text. If members are preceded by data icons or node icons, then use the tab position to left-align the icons instead of the members. Tab position is measured in pixels.

When there is no prefix preceding a member, then the return value of this method should be zero.

Parameters:

position - The position at which you want members to be left-aligned, in pixels.

getCellHeightPadValue

public int getCellHeightPadValue()

Retrieves the extra height that is added to a cell when the default height of the cell makes the list look crowded. The default cell height correlates to the font size of the member and is measured in pixels. If there is no prefix displayed before the member text, then the return value of this method is zero.

Returns:

The extra height that is added to a cell, in pixels.

setCellHeightPadValue

public void setCellHeightPadValue(int value)

Specifies the extra height to add to a cell when the default height of the cell makes the list look crowded. The default cell height correlates to the font size of the member and is measured in pixels.

If there is no prefix displayed before the member text, then the param value of this method is automatically set to zero.

Parameters:

value - The extra height that you want to add to a cell, in pixels.

getClosedIcon

public javax.swing.Icon getClosedIcon()

Retrieves an icon that indicates that a member is not showing its children in the list. For example, this icon might be a file folder that is closed. You can double-click this icon to drill down.

To display this icon, set the setContextIconVisible method to true.

Returns:

The icon that indicates that a member is not showing its children.

See Also:

setContextIconVisible(boolean)

getCollapsedIcon

public javax.swing.Icon getCollapsedIcon()

Retrieves an icon that indicates that a member is collapsed. For example, this icon might be a plus sign. You can click this icon to drill down.

To display drill icons, set the setIconVisible method to true.

Returns:

The icon that indicates that a member is collapsed.

See Also:

setIconVisible(boolean)

getCount

public int getCount()

Retrieves the total number of members in the model.

Returns:

The total number of members in the model.

getEditable

public boolean getEditable()

Retrieves the value that indicates whether you can edit members.

Returns:

true if you can edit members, false if you cannot.

getEditIndex

public int getEditIndex()

Retrieves the index of the member that is being edited. The index is the position of the member in the model.

Returns:

The index of the member that is being edited.

getEndIndex

public long getEndIndex()

Retrieves the index of the position in which the dragged member was dropped, in the model.

Returns:

The index of the position in which the dragged member was dropped.

getExpandedIcon

public javax.swing.Icon getExpandedIcon()

Retrieves the icon that indicates that a member is expanded. For example, this icon might be a minus sign. You can click this icon to drill up.

To display drill icons, set the setIconVisible method to true.

Returns:

The icon that indicates that a member is expanded.

See Also:

setIconVisible(boolean)

getFirstVisibleIndex

public int getFirstVisibleIndex()

Retrieves the index of the first visible member on the screen. The index is the position of the member in the model.

Overrides:

getFirstVisibleIndex in class javax.swing.JList

Returns:

The index of the first visible member on the screen.

getNodeIcon

public javax.swing.Icon getNodeIcon()

Retrieves the icon that indicates that a member is at the lowest hierarchical level. A member that is at the lowest hierarchical level is sometimes referred to as a leaf.

Returns:

The icon that indicates that a member is at the lowest hierarchical level.

getOpenedIcon

public javax.swing.Icon getOpenedIcon()

Retrieves an icon that indicates that a member is showing its children in the list. For example, this icon might be a file folder that is open. You can double-click this icon to drill up.

To display this icon, set the setContextIconVisible method to true.

Returns:

The icon that indicates that a member is showing its children.

See Also:

setContextIconVisible(boolean)

getStartIndex

public long getStartIndex()

Retrieves the index of the member that is being dragged. The index is the original position of the member in the model.

Returns:

The index of the member that is being dragged.

isContextIconVisible

public boolean isContextIconVisible()

Indicates whether the Opened and Closed icons are displayed for members in the list.

Returns:

true if the Opened and Closed icons are displayed, false if they are not displayed.

See Also:

setClosedIcon(javax.swing.Icon), setOpenedIcon(javax.swing.Icon)

isIconVisible

public boolean isIconVisible()

Indicates whether icons are displayed for collapsed and expanded members in the list.

Returns:

true if icons are displayed for members that are expanded or collapsed, false if they are not displayed.

See Also:

setCollapsedIcon(javax.swing.Icon), setExpandedIcon(javax.swing.Icon)

isToolTipsEnabled

public boolean isToolTipsEnabled()

Indicates whether tooltips are displayed when the mouse is over a tool.

Returns:

true if tooltips are displayed, false if they are not.

See Also:

setToolTipsEnabled(boolean)

removeDimensionListListener

public void removeDimensionListListener(DimensionListListener l)

Removes a DimensionListListener from this object.

Parameters:

l - The DimensionListListener that you want to remove.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Removes a PropertyChangeListener from this object.

Overrides:

removePropertyChangeListener in class javax.swing.JComponent

Parameters:

l - The PropertyChangeListener that you want to remove.

setCellEditor

public void setCellEditor(DimListCellEditor anEditor)

Specifies the current cell editor.

Parameters:

anEditor - The CellEditor object that you want to use.

setClosedIcon

public void setClosedIcon(javax.swing.Icon icon)

Specifies an icon to indicate that a member is not showing its children in the list. For example, this icon might be a file folder that is closed. You can double-click this icon to drill down.

To display this icon, you must set the setContextIconVisible method to true.

Parameters:

icon - The icon that you want to use to indicate that a member is not showing its children.

See Also:

setContextIconVisible(boolean)

setCollapsedIcon

public void setCollapsedIcon(javax.swing.Icon icon)

Specifies an icon to indicate that a member is collapsed. For example, this icon might be a plus sign. You can click this icon to drill down.

Parameters:

icon - The icon that you want to use to indicate that a member is collapsed.

setContextIconVisible

public void setContextIconVisible(boolean visible)

Specifies whether the Opened and Closed icons are displayed with the members in a list.

Parameters:

true - if the Opened and Closed icons are displayed, false if they are not.

See Also:

setClosedIcon(javax.swing.Icon), setOpenedIcon(javax.swing.Icon)

setEditable

public void setEditable(boolean flag)

Specifies whether you can edit members.

Parameters:

flag - true to edit members, false otherwise.

setEditIndex

public void setEditIndex(int index)

Specifies the index of the member that is being edited. The index is the position of the member in the model.

Parameters:

index - The index of the member that is being edited.

setExpandedIcon

public void setExpandedIcon(javax.swing.Icon icon)

Specifies the icon to indicate that a member has been expanded. For example, this icon might be a minus sign. You can click this icon to drill up.

Parameters:

icon - The icon that indicates that a member is expanded.

setFirstVisibleIndex

public void setFirstVisibleIndex(int index)

Specifies the index of the first visible member on the screen. The index is the position of the member in the model.

Parameters:

index - The index of the first visible member on the screen.

setIconVisible

public void setIconVisible(boolean visible)

Specifies whether to display icons for collapsed and expanded members in the list.

Parameters:

visible - true to display icons for members that are expanded or collapsed, false otherwise.

See Also:

setCollapsedIcon(javax.swing.Icon), setExpandedIcon(javax.swing.Icon)

setModel

public void setModel(DimListDataModel model)

Specifies the data model for this dimension list.

Parameters:

model - The DimListDataModel object that you want to use for this dimension list.

See Also:

DimListDataModel

setNodeIcon

public void setNodeIcon(javax.swing.Icon icon)

Specifies the icon that indicates that a member is at the lowest hierarchical level. A member that is at the lowest hierarchical level is sometimes referred to as a leaf.

Parameters:

icon - The icon that you want to use to indicate that a member is at the lowest hierarchical level.

setOpenedIcon

public void setOpenedIcon(javax.swing.Icon icon)

Specifies the icon that indicates that a member is showing its children in the list. For example, this icon might be a file folder that is open.

To display this icon, set the setContextIconVisible method to true.

Returns:

The icon that indicates that a member is showing its children.

See Also:

setContextIconVisible(boolean)

setToolTipsEnabled

public void setToolTipsEnabled(boolean flag)

Specifies whether tooltips are displayed when the mouse is over a tool.

Parameters:

flag - true to display tooltips, false otherwise.