oracle.dss.util.dimensionList
Class DimensionListPanel

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JPanel
                          |
                          +--oracle.dss.util.dimensionList.DimensionListPanel

All Implemented Interfaces:

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

Direct Known Subclasses:

OLAPDimensionListPanel

public class DimensionListPanel

extends javax.swing.JPanel

implements java.awt.event.ActionListener, javax.swing.event.ListSelectionListener, javax.swing.event.ListDataListener, DimFindEventListener, java.io.Serializable

A panel that contains a dimension list, a count label, and a toolbar that are all visible by default.

See Also:

Serialized Form

Inner classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

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

DimensionListPanel()
Deprecated. As of 2.6.0.21, replaced by DimensionListPanel(Dialog) or by DimensionListPanel(Frame).

DimensionListPanel(DataAccess dataAccess, MemberListAccess memberAccess, java.lang.String dimension, java.lang.String type, boolean isTable)
Deprecated. As of 2.6.0.21, replaced by DimensionListPanel(Dialog, DataAccess, MemberListAccess, String, String, boolean) or by DimensionListPanel(Frame, DataAccess, MemberListAccess, String, String, boolean).

DimensionListPanel(java.awt.Dialog parent)
Constructor that specifies the dialog to serve as the parent of any subdialogs of the DimensionListPanel.

DimensionListPanel(java.awt.Dialog parent, DataAccess dataAccess, MemberListAccess memberAccess, java.lang.String dimension, java.lang.String type, boolean isTable)
Constructor that specifies all arguments for displaying the DimensionListPanel with a dialog as the parent.

DimensionListPanel(java.awt.Frame parent)
Constructor that specifies the frame to serve as the parent of any subdialogs of the DimensionListPanel.

DimensionListPanel(java.awt.Frame parent, DataAccess dataAccess, MemberListAccess memberAccess, java.lang.String dimension, java.lang.String type, boolean isTable)
Constructor that specifies all arguments for displaying the DimensionListPanel with a frame as the parent.

Method Summary

void	addDimensionListListener(DimensionListListener l) Adds a DimensionListListener to this object.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Adds a PropertyChangeListener to this object.
boolean	clearSelection() Deselects any members that are currently selected.
javax.swing.Icon	getClosedIcon() Retrieves an icon that indicates that a member is not showing its children in the list.
javax.swing.Icon	getCollapseAllIcon() Retrives the icon for the toolbar button that collapses all of the members in the list.
javax.swing.Icon	getCollapsedIcon() Retrieves the icon that indicates that a member is collapsed.
int	getCount() Retrieves the total number of members in the model.
java.lang.String	getDimension() Retrieves the name of the dimension for this dimension list, such as D_P0.
DimensionList	getDimensionList() Retrieves the dimension list for this panel.
java.lang.String	getDimensionName() Retrieves the name of the dimension that you want to display.
javax.swing.Icon	getExpandAllIcon() Retrieves the icon for the toolbar button that expands all of the members in the list.
javax.swing.Icon	getExpandedIcon() Retrieves the icon that indicates that a member is expanded.
javax.swing.Icon	getFindIcon() Retrieves the icon for the toolbar button that displays the Find dialog.
oracle.bali.ewt.help.HelpProvider	getHelpProvider() Retrieves the HelpProvider.
java.lang.String	getHierarchy() Retrieves the name of the hierarchy for the dimension of this dimension list.
java.lang.String	getLabelType() Retrieves the type of label to display for the dimension members.
java.util.Locale	getLocale() Retrieves the locale for this component.
javax.swing.Icon	getNodeIcon() Retrieves the icon that indicates a member at the lowest hierarchical level, sometimes referred to as a leaf.
javax.swing.Icon	getOpenedIcon() Retrieves the icon that indicates that a member is showing its children in the list.
java.awt.Dimension	getPreferredSize() Retrieves the preferred size of the DimensionListPanel.
int	getSelectedIndex() Specifies the index of the member that is selected.
java.lang.String	getSelectedMember() Retrieves the selected member.
java.util.Vector	getSelectedMembers() Retrieves a vector that contains the selected members.
java.util.Vector	getSelectedMembers(boolean getDescription) Retrieves a vector that contains either the descriptions or the values of the selected members.
DimListSelectionModel	getSelectionModel() Retrieves the DimensionListSelectionModel for this dimension list.
void	initDimensionListPanel(java.lang.String strDimension, dataAccessDimensionModel, boolean isHierarchical) Initializes the DimensionListPanel.
boolean	isCountLabelVisible() Indicates whether the count label for the panel is visible.
boolean	isHierarchical() Indicates whether the dimension list is displayed with indentation that indicates hierarchies.
boolean	isHierarchyVisible() Indicates whether the drop-down list of hierarchies and levels is visible on the toolbar.
boolean	isSelectionEmpty() Indicates whether any members are currently selected.
boolean	isToolbarVisible() Indicates whether the toolbar for the dimension list is visible.
void	removeDimensionListListener(DimensionListListener l) Removes a DimensionListListener from this object.
void	removePropertyChangeListener(java.beans.PropertyChangeListener l) Removes a PropertyChangeListener from this object.
void	setClosedIcon(javax.swing.Icon icon) Specifies an icon that indicates that a member is not showing its children in the list.
void	setCollapseAllIcon(javax.swing.Icon icon) Specifies the icon for the toolbar button that collapses all of the members in the list.
void	setCollapsedIcon(javax.swing.Icon icon) Specifies the icon that indicates that a member is collapsed.
void	setCountLabelVisible(boolean visible) Specifies whether the count label for the panel is visible.
void	setDimension(java.lang.String strDimension) Specifies the name of the dimension for this dimension list, such as D_P0.
void	setDimensionName(java.lang.String dimName) Specifies the name of the dimension that you want to display.
void	setExpandAllIcon(javax.swing.Icon icon) Specifies the icon for the toolbar button that expands all of the members in the list.
void	setExpandedIcon(javax.swing.Icon icon) Specifies the icon that indicates that a member is expanded.
void	setFindIcon(javax.swing.Icon icon) Specifies the icon for the toolbar button that displays the Find dialog.
void	setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider) Specifies the HelpProvider.
void	setHierarchical(boolean blnIsHierarchical) Specifies the Boolean value that determines whether the dimension list is displayed with indentation that indicates hierarchies.
void	setHierarchy(java.lang.String strHierarchy) Specifies the name of the hierarchy for the dimension of this dimension list.
void	setHierarchyVisible(boolean visible) Specifies whether the drop-down list of hierarchies and levels is visible on the toolbar.
void	setLabelType(java.lang.String type) Specifies the type of label to display for the dimension members.
void	setLocale(java.util.Locale locale) Specifies the locale for this component.
void	setModel( dataAccessDimensionModel) Specifies the DataDirectorDimensionModel for this dimension list.
void	setNodeIcon(javax.swing.Icon icon) Specifies the icon that indicates a member at the lowest hierarchical level, sometimes referred to as a leaf.
void	setOpenedIcon(javax.swing.Icon icon) Specifies the icon that indicates that a member is showing its children in the list.
void	setSelectedIndex(int index) Specifies the index of the member that you want to select.
void	setSelectionMode(int selectionMode) Specifies the selection mode for this component.
void	setSelectionModel(DimListSelectionModel selectionModel) Retrieves the DimensionListSelectionModel for this dimension list.
void	setToolbarVisible(boolean visible) Specifies whether the toolbar for the dimension list is visible.
void	updateDimensionListModel() Updates the data model.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUIClassID, 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, 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, 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, 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, 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 java.awt.event.ActionListener

actionPerformed

Methods inherited from interface javax.swing.event.ListSelectionListener

valueChanged

Methods inherited from interface javax.swing.event.ListDataListener

contentsChanged, intervalAdded, intervalRemoved

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

processDimFindEvent

Constructor Detail

DimensionListPanel

public DimensionListPanel()

Deprecated. As of 2.6.0.21, replaced by DimensionListPanel(Dialog) or by DimensionListPanel(Frame).

A DimensionListPanel should have a parent dialog or frame associated with it to ensure proper focus handling.

DimensionListPanel

public DimensionListPanel(java.awt.Frame parent)

Constructor that specifies the frame to serve as the parent of any subdialogs of the DimensionListPanel.

Parameters:

parent - The frame to serve as the parent.

DimensionListPanel

public DimensionListPanel(java.awt.Dialog parent)

Constructor that specifies the dialog to serve as the parent of any subdialogs of the DimensionListPanel.

Parameters:

parent - The dialog to serve as the parent.

DimensionListPanel

public DimensionListPanel(DataAccess dataAccess,
MemberListAccess memberAccess,
                          java.lang.String dimension,
                          java.lang.String type,
                          boolean isTable)

Deprecated. As of 2.6.0.21, replaced by DimensionListPanel(Dialog, DataAccess, MemberListAccess, String, String, boolean) or by DimensionListPanel(Frame, DataAccess, MemberListAccess, String, String, boolean).

A DimensionListPanel should have a parent dialog or frame associated with it to ensure proper focus handling. Application developers should not use this constructor; it is for internal use only.

Parameters:

dataAccess - The DataAccess object.

memberAccess - The MemberListAccess object.

dimension - The dimension whose members are displayed in this DimensionListPanel.

type - A constant that represents the label for the dimension members, such as MetadataMap.METADATA_LONGLABEL.

isTable - true if the view is a table, false if the view is a crosstab.

See Also:

MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL

DimensionListPanel

public DimensionListPanel(java.awt.Frame parent,
DataAccess dataAccess,
MemberListAccess memberAccess,
                          java.lang.String dimension,
                          java.lang.String type,
                          boolean isTable)

Constructor that specifies all arguments for displaying the DimensionListPanel with a frame as the parent. Application developers should not use this constructor; it is for internal use only.

Parameters:

parent - The frame to serve as the parent.

dataAccess - The DataAccess object.

memberAccess - The MemberListAccess object.

dimension - The dimension whose members are displayed in this DimensionListPanel.

type - A constant that represents the label for the dimension members, such as MetadataMap.METADATA_LONGLABEL.

isTable - true if the view is a table, false if the view is a crosstab.

See Also:

MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL

DimensionListPanel

public DimensionListPanel(java.awt.Dialog parent,
DataAccess dataAccess,
MemberListAccess memberAccess,
                          java.lang.String dimension,
                          java.lang.String type,
                          boolean isTable)

Constructor that specifies all arguments for displaying the DimensionListPanel with a dialog as the parent. Application developers should not use this constructor; it is for internal use only.

Parameters:

parent - The dialog to serve as the parent.

dataAccess - The DataAccess object.

memberAccess - The MemberListAccess object.

dimension - The dimension whose members are displayed in this DimensionListPanel.

type - A constant that represents the label for the dimension members, such as MetadataMap.METADATA_LONGLABEL.

isTable - true if the view is a table, false if the view is a crosstab.

See Also:

MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL

Method Detail

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

Adds a PropertyChangeListener to this object. Use a PropertyChangeListener to listen for changes in the properties of the dimension list.

Overrides:

addPropertyChangeListener in class javax.swing.JComponent

Parameters:

l - The PropertyChangeListener that you want to add.

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener l)

Removes a PropertyChangeListener from this object. A PropertyChangeListener is used to listen for changes in the properties of the dimension list.

Overrides:

removePropertyChangeListener in class javax.swing.JComponent

Returns:

The PropertyChangeListener that you want to remove.

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.

See Also:

DimensionListListener

removeDimensionListListener

public void removeDimensionListListener(DimensionListListener l)

Removes a DimensionListListener from this object. A DimensionListListener is used to listen for changes in the dimension list.

Returns:

The DimensionListListener that you want to remove.

See Also:

DimensionListListener

getPreferredSize

public java.awt.Dimension getPreferredSize()

Retrieves the preferred size of the DimensionListPanel. The default preferred size is the default size of a JList.

Overrides:

getPreferredSize in class javax.swing.JComponent

Returns:

The preferred size of the DimensionListPanel.

getDimensionList

public DimensionList getDimensionList()

Retrieves the dimension list for this panel.

Returns:

The DimensionList object for this panel.

setCountLabelVisible

public void setCountLabelVisible(boolean visible)

Specifies whether the count label for the panel is visible. The count label displays the index of the selected member in the visible list of members, not the index of the member in the model.

For example, if there are 5 members in the visible list and the third member is selected, then the count label should display: "3 of 5".

Parameters:

visible - true to make the count label visible, false to hide it.

isCountLabelVisible

public boolean isCountLabelVisible()

Indicates whether the count label for the panel is visible. The count label displays the index of the selected member in the visible list of members, not the index of the member in the model.

For example, if there are 5 members in the visible list and the third member is selected, then the count label should display: "3 of 5".

Parameters:

visible - true if the count label is visible, false if it is hidden.

setLabelType

public void setLabelType(java.lang.String type)

Specifies the type of label to display for the dimension members. For example: A member named "All Geographies of the World" might have a long label of "All Geographies of the World", a medium label of "All Geog of the World", and a short label of "All World Geog". The default label type might be long, medium, or short.

Parameters:

type - The constant that represents the type of labels to display for the dimension members.

See Also:

MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL

getLabelType

public java.lang.String getLabelType()

Retrieves the type of label to display for the dimension members. For example: A member named "All Geographies of the World" might have a long label of "All Geographies of the World", a medium label of "All Geog of the World", and a short label of "All World Geog". The default label type might be long, medium, or short.

Returns:

The constant that represents the type of labels that are displayed for the dimension members.

See Also:

MetadataMap.METADATA_LONGLABEL, MetadataMap.METADATA_MEDIUMLABEL, MetadataMap.METADATA_SHORTLABEL

setToolbarVisible

public void setToolbarVisible(boolean visible)

Specifies whether the toolbar for the dimension list is visible. The toolbar is visible by default.

Parameters:

visible - true to make the toolbar visible, false to hide it.

isToolbarVisible

public boolean isToolbarVisible()

Indicates whether the toolbar for the dimension list is visible. The toolbar is visible by default.

Returns:

true if the toolbar is visible, false if it is not visible.

setHierarchyVisible

public void setHierarchyVisible(boolean visible)

Specifies whether the drop-down list of hierarchies and levels is visible on the toolbar. The drop-down list of hierarchies and levels is visible by default.

Parameters:

visible - true to make the drop-down list visible, false to hide it.

isHierarchyVisible

public boolean isHierarchyVisible()

Indicates whether the drop-down list of hierarchies and levels is visible on the toolbar. The drop-down list of hierarchies and levels is visible by default.

Parameters:

visible - true if the drop-down list isvisible, false if it is hidden.

setDimensionName

public void setDimensionName(java.lang.String dimName)

Specifies the name of the dimension that you want to display.

Parameters:

dimName - The name of the dimension that you want to display.

getDimensionName

public java.lang.String getDimensionName()

Retrieves the name of the dimension that you want to display.

Parameters:

dimName - The name of the dimension that you want to display.

getSelectionModel

public DimListSelectionModel getSelectionModel()

Retrieves the DimensionListSelectionModel for this dimension list.

Returns:

The DimensionListSelectionModel for this dimension list.

setSelectionModel

public void setSelectionModel(DimListSelectionModel selectionModel)

Retrieves the DimensionListSelectionModel for this dimension list.

Parameters:

selectionModel - The DimensionListSelectionModel for this dimension list.

clearSelection

public boolean clearSelection()

Deselects any members that are currently selected.

Returns:

true if successful, false otherwise.

isSelectionEmpty

public boolean isSelectionEmpty()

Indicates whether any members are currently selected.

Returns:

true if no members are selected, false otherwise.

getCount

public int getCount()

Retrieves the total number of members in the model.

Returns:

The total number of members in the model.

setSelectedIndex

public void setSelectedIndex(int index)

Specifies the index of the member that you want to select. The index is the position of the member in the model.

Parameters:

index - The index of the member in the model that you want to select.

getSelectedIndex

public int getSelectedIndex()

Specifies the index of the member that is selected. Index is the position of the member in the model.

Parameters:

index - The index of the member in the model that is selected, or -1 if no member is selected.

setExpandedIcon

public void setExpandedIcon(javax.swing.Icon icon)

Specifies 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.

Parameters:

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

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.

Returns:

The icon that indicates that a member is expanded.

setCollapsedIcon

public void setCollapsedIcon(javax.swing.Icon icon)

Specifies the 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.

Parameters:

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

getCollapsedIcon

public javax.swing.Icon getCollapsedIcon()

Retrieves the 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.

Returns:

The icon that indicates that a member is collapsed.

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 sheet of paper with the mathematical sign for sum on it. You can double-click this icon to drill up.

Parameters:

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

getOpenedIcon

public javax.swing.Icon getOpenedIcon()

Retrieves the icon that indicates that a member is showing its children in the list. For example, this icon might be a sheet of paper with the mathematical sign for sum on it. You can double-click this icon to drill up.

Returns:

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

setClosedIcon

public void setClosedIcon(javax.swing.Icon icon)

Specifies an icon that indicates that a member is not showing its children in the list. For example, this icon might be a sheet of paper with the mathematical sign for sum on it. You can double-click this icon to drill down.

Parameters:

icon - The icon that indicates that a memer is not showing its children.

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 sheet of paper with the mathematical sign for sum on it. You can double-click this icon to drill down.

Returns:

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

setNodeIcon

public void setNodeIcon(javax.swing.Icon icon)

Specifies the icon that indicates a member at the lowest hierarchical level, sometimes referred to as a leaf. For example, this icon might be a blue dot.

Parameters:

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

getNodeIcon

public javax.swing.Icon getNodeIcon()

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

Returns:

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

setExpandAllIcon

public void setExpandAllIcon(javax.swing.Icon icon)

Specifies the icon for the toolbar button that expands all of the members in the list. For example, this icon might be two plus signs.

Parameters:

icon - The icon for the toolbar button that expands all of the members in the list.

getExpandAllIcon

public javax.swing.Icon getExpandAllIcon()

Retrieves the icon for the toolbar button that expands all of the members in the list. For example, this icon might be two plus signs.

Returns:

The icon for the toolbar button that expands all of the members in the list.

setCollapseAllIcon

public void setCollapseAllIcon(javax.swing.Icon icon)

Specifies the icon for the toolbar button that collapses all of the members in the list. For example, this icon might be two minus signs.

Parameters:

icon - The icon for the toolbar button that collapses all of the members in the list.

getCollapseAllIcon

public javax.swing.Icon getCollapseAllIcon()

Retrives the icon for the toolbar button that collapses all of the members in the list. For example, this icon might be two minus signs.

Returns:

The icon for the toolbar button that collapses all of the members in the list.

setFindIcon

public void setFindIcon(javax.swing.Icon icon)

Specifies the icon for the toolbar button that displays the Find dialog.

Parameters:

icon - The icon for the toolbar button that displays the Find dialog.

getFindIcon

public javax.swing.Icon getFindIcon()

Retrieves the icon for the toolbar button that displays the Find dialog.

Returns:

The icon for the toolbar button that displays the Find dialog.

setModel

public void setModel( dataAccessDimensionModel)

Specifies the DataDirectorDimensionModel for this dimension list. DataDirectorDimensionModel is an implementation of DimListDataModel that provides special properties for the dimension list beans.

Parameters:

dataDirectorDimensionModel - The DataDirectorDimensionModel for this dimension list.

getDimension

public java.lang.String getDimension()

Retrieves the name of the dimension for this dimension list, such as D_P0.

Returns:

The name of the dimension for this dimension list or null.

setDimension

public void setDimension(java.lang.String strDimension)

Specifies the name of the dimension for this dimension list, such as D_P0.

Parameters:

strDimension - The name of the dimension for this dimension list.

getHierarchy

public java.lang.String getHierarchy()

Retrieves the name of the hierarchy for the dimension of this dimension list.

Returns:

The name of the hierarchy for the dimension of this dimension list or null.

setHierarchy

public void setHierarchy(java.lang.String strHierarchy)

Specifies the name of the hierarchy for the dimension of this dimension list.

Parameters:

strHierarchy - The name of the hierarchy for the dimension of this dimension list or null.

isHierarchical

public boolean isHierarchical()

Indicates whether the dimension list is displayed with indentation that indicates hierarchies.

Returns:

true if the list is displayed with indentations, false if it is not.

setHierarchical

public void setHierarchical(boolean blnIsHierarchical)

Specifies the Boolean value that determines whether the dimension list is displayed with indentation that indicates hierarchies.

Parameters:

blnIsHierarchical - true to display the list with indentations, false to display the list with all members in a flat list without indentation.

initDimensionListPanel

public void initDimensionListPanel(java.lang.String strDimension,
                                    dataAccessDimensionModel,
                                   boolean isHierarchical)

Initializes the DimensionListPanel.

Parameters:

guiContext - A GuiContext object that contains methods for specifying and retrieving objects, such as MetadataManager, ParentFrame, PersistenceManager and QueryContext.

strDimension - The name of the dimension that you want to display.

dataDirectorDimensionModel - The DataDirectorDimensionModel object for this dimension list.

isHierarchical - true to display the list with indentation that indicates a hierarchy, fasle to display a flat list, without indentation.

getSelectedMembers

public java.util.Vector getSelectedMembers(boolean getDescription)

Retrieves a vector that contains either the descriptions or the values of the selected members. The descriptions correspond to the labels that are set on the data model.

Parameters:

getDescription - true to return the descriptions of the selected members, false to return the values of the selected members.

Returns:

Vector that contains the selected members.

getSelectedMembers

public java.util.Vector getSelectedMembers()

Retrieves a vector that contains the selected members.

Returns:

Vector that contains the selected members.

See Also:

getSelectedMembers(boolean)

getSelectedMember

public java.lang.String getSelectedMember()

Retrieves the selected member.

Returns:

The selected member.

updateDimensionListModel

public void updateDimensionListModel()

Updates the data model.

getLocale

public java.util.Locale getLocale()

Retrieves the locale for this component.

Overrides:

getLocale in class java.awt.Component

Returns:

The locale.

setLocale

public void setLocale(java.util.Locale locale)

Specifies the locale for this component.

Overrides:

setLocale in class java.awt.Component

Parameters:

locale - The locale.

setHelpProvider

public void setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider)

Specifies the HelpProvider.

Parameters:

helpProvider - The HelpProvider.

getHelpProvider

public oracle.bali.ewt.help.HelpProvider getHelpProvider()

Retrieves the HelpProvider.

Returns:

The HelpProvider.

setSelectionMode

public void setSelectionMode(int selectionMode)

Specifies the selection mode for this component. You can allow only a single element to be selected; multiple elements to be selected, but only in a single continuous interval; or multiple elements in multiple intervals to be selected.

Parameters:

selectionMode - The selection mode.

See Also:

ListSelectionModel.SINGLE_SELECTION, ListSelectionModel.SINGLE_INTERVAL_SELECTION, ListSelectionModel.MULTIPLE_INTERVAL_SELECTION