oracle.dss.util.dimensionList
Interface DimListDataModel

All Superinterfaces:

javax.swing.ComboBoxModel, javax.swing.ListModel

All Known Implementing Classes:

OLAPDimensionModel

public interface DimListDataModel

extends javax.swing.ComboBoxModel

Defines constants and methods for all of the dimension list models.

See Also:

DimensionCombo, DimensionList, DimensionListPanel

Field Summary

static int	COLLAPSE Drill type: Collapse.
static int	COLLAPSEALL_FLAG Indicates that the dimension list is fully collapsed when it is initially displayed.
static int	EXPAND Drill type: Expand.
static int	EXPANDALL_FLAG Indicates that the dimension list is fully expanded when it is initially displayed.

Method Summary

boolean	collapseAll() Fully collapses the dimension list to the highest hierarchical level.
boolean	drill(int index, int drillType) Drills the specified item.
java.lang.Object	elementAt(int index) Retrieves the item at the specified position in the model.
boolean	expandAll() Fully expands the dimension list to the lowest hierarchical level.
int	find(java.lang.String search, int flags, int startPos) Searches for a matching item according to the specified criteria.
boolean	isDragable(long index) Indicates whether you can drag the specified item.
boolean	isDropTarget(long index, java.lang.Object o) Indicates whether you can drop this item in the specified position in the model.
boolean	isHierarchical() Indicates whether this data model supports a hierarchical display of data.
void	moveElement(int indexFrom, int indexTo) Moves an item from the specified position in the model to the target position in the model.
void	refresh() Refreshes the dimension list to reflect the current selections.
void	setElementAt(java.lang.Object item, int index) Specifies an object to be inserted at the specified position in the model.
int	size() Retrieves the total count of items in the model.

Methods inherited from interface javax.swing.ComboBoxModel

getSelectedItem, setSelectedItem

Methods inherited from interface javax.swing.ListModel

addListDataListener, getElementAt, getSize, removeListDataListener

Field Detail

COLLAPSE

public static final int COLLAPSE

Drill type: Collapse.

EXPAND

public static final int EXPAND

Drill type: Expand.

EXPANDALL_FLAG

public static final int EXPANDALL_FLAG

Indicates that the dimension list is fully expanded when it is initially displayed.

COLLAPSEALL_FLAG

public static final int COLLAPSEALL_FLAG

Indicates that the dimension list is fully collapsed when it is initially displayed.

Method Detail

collapseAll

public boolean collapseAll()

Fully collapses the dimension list to the highest hierarchical level.

Returns:

true if the collapse is successful, false if it is not.

drill

public boolean drill(int index,
                     int drillType)

Drills the specified item.

Parameters:

index - The index of the item that you want to drill. The index represents the item's position in the model.

drillType - A constant that represents the drill operation that you want to perform on this item.

Returns:

true if the drill is successful, false if it is not.

See Also:

COLLAPSE, EXPAND

expandAll

public boolean expandAll()

Fully expands the dimension list to the lowest hierarchical level.

Returns:

true if the expansion is successful, false if it is not.

find

public int find(java.lang.String search,
                int flags,
                int startPos)

Searches for a matching item according to the specified criteria.

Parameters:

search - A String that contains the characters that you want to match.

flags - A constant or constants that represent specific information about the search. You can combine constants by using the or operator.

startPos - The index of the position from which you want to start the search in the model.

Returns:

int The index of the matching item in the model.

elementAt

public java.lang.Object elementAt(int index)

Retrieves the item at the specified position in the model.

Parameters:

index - The position of the item in the model.

Returns:

The item at the specified position in the model, or null if there is an error.

size

public int size()

Retrieves the total count of items in the model.

Returns:

The total count of items in the model.

moveElement

public void moveElement(int indexFrom,
                        int indexTo)

Moves an item from the specified position in the model to the target position in the model.

Parameters:

indexFrom - The position of the item that you want to move.

indexTo - The position that you want to move this item to.

setElementAt

public void setElementAt(java.lang.Object item,
                         int index)

Specifies an object to be inserted at the specified position in the model.

Parameters:

item - The item that you want to specify.

index - The position for which you want to specify an item.

isDragable

public boolean isDragable(long index)

Indicates whether you can drag the specified item.

Parameters:

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

Returns:

true if you can drag the item, false if you cannot.

isDropTarget

public boolean isDropTarget(long index,
                            java.lang.Object o)

Indicates whether you can drop this item in the specified position in the model.

Parameters:

index - The position in which you want to drop this item.

o - The item that you want to drop.

Returns:

true if you can drop this item in the specified position, false if you cannot.

refresh

public void refresh()

Refreshes the dimension list to reflect the current selections.

isHierarchical

public boolean isHierarchical()

Indicates whether this data model supports a hierarchical display of data.

Returns:

true if this data model supports a hierarchical display of data, false if it does not.