oracle.dss.datautil.gui.dimensionList
Class DimensionListDialog

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.Window
                    |
                    +--java.awt.Dialog
                          |
                          +--javax.swing.JDialog
                                |
                                +--oracle.bali.ewt.dialog.JEWTDialog
                                      |
                                      +--oracle.dss.datautil.gui.StandardDialog
                                            |
                                            +--oracle.dss.datautil.gui.dimensionList.DimensionListDialog

All Implemented Interfaces:

javax.accessibility.Accessible, HelpContext, java.awt.image.ImageObserver, java.awt.MenuContainer, javax.swing.RootPaneContainer, java.io.Serializable, javax.swing.WindowConstants

public class DimensionListDialog

extends StandardDialog

Displays the OLAPDimensionListPanel in a dialog that also contains standard dialog buttons, such as Help, OK and Cancel.

See Also:

OLAPDimensionListPanel, Serialized Form

Fields inherited from class oracle.dss.datautil.gui.StandardDialog

CANCEL, OK, UNDEFINED

Fields inherited from class oracle.bali.ewt.dialog.JEWTDialog

ACTION_APPLY, BUTTON_APPLY, BUTTON_CANCEL, BUTTON_CLOSE, BUTTON_DEFAULT, BUTTON_HELP, BUTTON_NONE, BUTTON_OK, PROPERTY_CLOSED

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

DimensionListDialog(java.awt.Dialog parent, QueryAccessDimensionModel qadm, java.awt.Component invoker, boolean isModal)
Constructor that specifies all arguments for displaying the DimensionListDialog with a dialog as its parent.

DimensionListDialog(java.awt.Frame parent, QueryAccessDimensionModel qadm, java.awt.Component invoker, boolean isModal)
Constructor that specifies all arguments for displaying the DimensionListDialog with a frame as its parent.

DimensionListDialog(QueryAccessDimensionModel qadm, java.awt.Component invoker)
Deprecated. As of 2.6.0.21, replaced by DimensionListDialog(Dialog, QueryAccessDimensionModel, Component, boolean) or by DimensionListDialog(Frame, QueryAccessDimensionModel, Component, boolean).

DimensionListDialog(QueryAccessDimensionModel qadm, java.awt.Component invoker, boolean isModal)
Deprecated. As of 2.6.0.21, replaced by DimensionListDialog(Dialog, QueryAccessDimensionModel, Component, boolean) or by DimensionListDialog(Frame, QueryAccessDimensionModel, Component, boolean).

Method Summary

int	display() Displays this DimensionListDialog so that it is centered over the component that invokes it, which is often a button.
OLAPDimensionListPanel	getDimensionListPanel() Retrieves the DimensionListPanel that is contained by this dialog.
java.lang.String	getSelectedMember() Retrieves the name of the dimension member that is currently selected in the dimension list.
MemberStep	getSelectedMembers() Retrieves a MemberStep object that contains the dimension members that are currently selected in the DimensionListDialog.
boolean	isCountLabelVisible() Indicates whether the count label for the panel of this dialog is visible.
boolean	isToolbarVisible() Indicates whether the toolbar for the panel of this dialog is visible.
void	setCountLabelVisible(boolean visible) Specifies whether the count label for the panel of this dialog is visible.
void	setHelpProvider(oracle.bali.ewt.help.HelpProvider helpProvider) Specifies the HelpProvider.
void	setLocale(java.util.Locale locale) Specifies the locale for this component.
void	setSelectionMode(int selectionMode) Specifies the selection mode for this component.
void	setToolbarVisible(boolean visible) Specifies whether the toolbar for the panel of this dialog is visible.

Methods inherited from class oracle.dss.datautil.gui.StandardDialog

display, getHelpContextID, getHelpProvider, getReturnCode, setContent, setHelpContextID

Methods inherited from class oracle.bali.ewt.dialog.JEWTDialog

addActionListener, addCustomButton, addNotify, addPropertyChangeListener, addVetoableChangeListener, createDialog, dispose, getAccessibleContext, getButtonMask, getButtonMnemonic, getCancelButtonMnemonic, getCancelButtonText, getCenterOver, getContent, getCustomButton, getCustomButtonCount, getDefaultButton, getInitialFocus, getMaximunInitialSize, getMinimumSize, getOKButtonMnemonic, getOKButtonText, getPreferredSize, isCancelled, isDialogClosingEvent, isOKButtonEnabled, pack, removeActionListener, removeCustomButton, removePropertyChangeListener, removeVetoableChangeListener, runDialog, setButtonMask, setCancelButtonMnemonic, setCancelButtonText, setCenterOver, setDefaultButton, setInitialFocus, setMaximumInitialSize, setMaximumInitialSize, setMinimumSize, setMinimumSize, setOKButtonEnabled, setOKButtonMnemonic, setOKButtonText, setPreferredSize, setPreferredSize

Methods inherited from class javax.swing.JDialog

getContentPane, getDefaultCloseOperation, getGlassPane, getJMenuBar, getLayeredPane, getRootPane, remove, setContentPane, setDefaultCloseOperation, setGlassPane, setJMenuBar, setLayeredPane, setLayout, setLocationRelativeTo, update

Methods inherited from class java.awt.Dialog

getTitle, hide, isModal, isResizable, setModal, setResizable, setTitle, show

Methods inherited from class java.awt.Window

addWindowListener, applyResourceBundle, applyResourceBundle, getFocusOwner, getGraphicsConfiguration, getInputContext, getListeners, getLocale, getOwnedWindows, getOwner, getToolkit, getWarningString, isShowing, postEvent, removeWindowListener, setCursor, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, printComponents, remove, removeAll, removeContainerListener, removeNotify, setFont, validate

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, bounds, checkImage, checkImage, contains, contains, createImage, createImage, disable, dispatchEvent, enable, enable, enableInputMethods, getBackground, getBounds, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputMethodRequests, getLocation, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setDropTarget, setEnabled, setForeground, setLocation, setLocation, setName, setSize, setSize, setVisible, show, size, toString, transferFocus

Methods inherited from class java.lang.Object

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

Constructor Detail

DimensionListDialog

public DimensionListDialog(java.awt.Dialog parent,
QueryAccessDimensionModel qadm,
                           java.awt.Component invoker,
                           boolean isModal)

Constructor that specifies all arguments for displaying the DimensionListDialog with a dialog as its parent.

Parameters:

parent - The dialog to serve as the parent.

qadm - The data model for this DimensionListDialog object.

invoker - The component over which the DimensionListDialog is centered when it is displayed.

isModal - true if the dialog is modal, false if the dialog is not modal.

DimensionListDialog

public DimensionListDialog(java.awt.Frame parent,
QueryAccessDimensionModel qadm,
                           java.awt.Component invoker,
                           boolean isModal)

Constructor that specifies all arguments for displaying the DimensionListDialog with a frame as its parent.

Parameters:

parent - The frame to serve as the parent.

qadm - The data model for this DimensionListDialog object.

invoker - The component over which the DimensionListDialog is centered when it is displayed.

isModal - true if the dialog is modal, false if the dialog is not modal.

DimensionListDialog

public DimensionListDialog(QueryAccessDimensionModel qadm,
                           java.awt.Component invoker,
                           boolean isModal)

Deprecated. As of 2.6.0.21, replaced by DimensionListDialog(Dialog, QueryAccessDimensionModel, Component, boolean) or by DimensionListDialog(Frame, QueryAccessDimensionModel, Component, boolean).

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

Parameters:

qadm - The data model for this DimensionListDialog object.

invoker - The component over which the DimensionListDialog is centered when it is displayed.

isModal - true if the dialog is modal, false if the dialog is not modal.

DimensionListDialog

public DimensionListDialog(QueryAccessDimensionModel qadm,
                           java.awt.Component invoker)

Deprecated. As of 2.6.0.21, replaced by DimensionListDialog(Dialog, QueryAccessDimensionModel, Component, boolean) or by DimensionListDialog(Frame, QueryAccessDimensionModel, Component, boolean).

A DimensionListDialog should have a parent dialog or frame associated with it to ensure proper focus handling. This constructor does not include the modal specification.

Parameters:

qadm - The data model for this DimensionListDialog object.

invoker - The component over which the DimensionListDialog is centered when it is displayed.

Method Detail

display

public int display()

Displays this DimensionListDialog so that it is centered over the component that invokes it, which is often a button. You set the component that invokes this dialog in a constructor of this class.

Returns:

A constant that represents the return code. The valid constants are:

• OK
• CANCEL

See Also:

StandardDialog.OK, StandardDialog.CANCEL

getSelectedMember

public java.lang.String getSelectedMember()

Retrieves the name of the dimension member that is currently selected in the dimension list.

Returns:

The name of the dimension member that is currently selected.

getSelectedMembers

public MemberStep getSelectedMembers()

Retrieves a MemberStep object that contains the dimension members that are currently selected in the DimensionListDialog.

Returns:

The MemberStep object that contains the dimension members that are currently selected.

setCountLabelVisible

public void setCountLabelVisible(boolean visible)

Specifies whether the count label for the panel of this dialog is visible. The count label displays the index of the selected member in the visible list of items, not the index of the member in the model. The count label is visible by default.

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 of this dialog is visible. The count label displays the index of the selected member in the visible list of member, not the index of the member in the model. The count label is visible by default.

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

Returns:

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

setToolbarVisible

public void setToolbarVisible(boolean visible)

Specifies whether the toolbar for the panel of this dialog 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 panel of this dialog is visible. The toolbar is visible by default.

Returns:

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

getDimensionListPanel

public OLAPDimensionListPanel getDimensionListPanel()

Retrieves the DimensionListPanel that is contained by this dialog.

Returns:

The DimensionListPanel that is contained by this dialog.

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.

Overrides:

setHelpProvider in class StandardDialog

Parameters:

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