ilog.views.dashboard

Class IlvDashboardKeySelectManager

java.lang.Object

ilog.views.dashboard.IlvDashboardKeySelectManager

public class IlvDashboardKeySelectManager
extends Object

IlvDashboardKeySelectManager manages dashboard symbol key selection. This class is used by a IlvDashboardInteractor to select the IlvDashboardSymbol objects in a dashboard diagram. Symbols in a dashboard diagram are arranged in a selection chain. That is, an order of selection inside the diagram. IlvDashboardKeySelectManager manages and updates the selection chain in response to user actions.

Example

To use this selection manager with a dashboard diagram, create an IlvDashboardKeySelectManager object and attach it to the dashboard diagram view. The following code example shows how this is done.

 public void perform(ActionEvent e, IlvDiagrammer diagrammer) throws Exception {
   IlvDashboardDiagram source = (IlvDashboardDiagram) diagrammer;
   IlvDashboardContext context = new IlvDashboardContext();      
   IlvDashboardDiagram dashboard = new IlvDashboardDiagram(context);
   ...
   // Build the DOM
   DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
   DocumentBuilder builder = factory.newDocumentBuilder();
   Document document = builder.newDocument();
   Element dashboardDOM = IlvDashboardDOM.buildDashboardDOM(document, source);
   document.appendChild(dashboardDOM);
   // Read the contents
   IlvDashboardDOM.readDashboardDOM(dashboard, document);
       
   // Manage view interactor
   dashboard.getView().setInteractor(new IlvDashboardInteractor());
   
   
   // Manage keyboard focus selection
     dashboard.setSelectManager(new IlvDashboardKeySelectManager(dashboard));
   ...
   }
 

Since:

JViews 8.0

See Also:

IlvDashboardInteractor, IlvDashboardSymbol, IlvDashboardDiagram, IlvDashboardDiagram.setSelectManager(IlvDashboardKeySelectManager), IlvDashboardContext

Constructor Summary

Constructors

Constructor and Description
IlvDashboardKeySelectManager(IlvDashboardDiagram diagram) Constructs an IlvDashboardKeySelectManager object to be used with diagram

Method Summary

Modifier and Type	Method and Description
void	focusGained() Call focusGained() when the dashboard diagram attached to this selector gains the focus.
void	focusLost() Call focusLost() when the dashboard diagram attached to this selector gains the focus.
IlvDashboardSymbol	getSelected() Returns the currently selected symbol in the dashboard diagram.
protected void	insertSelectableSymbol(IlvDashboardSymbol symbol) Inserts a selectable symbol into the selection chain.
protected boolean	isAfter(IlvDashboardSymbol symbol, IlvDashboardSymbol reference) Compares the selection chain order for two symbols.
protected boolean	isSelectable(IlvDashboardSymbol symbol) Tests if the symbol is selectable.
void	removeSelectableSymbol(IlvDashboardSymbol symbol) Removes symbol from the selectable symbol chain.
void	select(IlvDashboardSymbol symbol) Selects a IlvDashboardSymbol in a dashboard diagram in response to a keyboard event.
void	selectAt(double x, double y, IlvManagerView view) Selects the object located at the (x,y) coordinate in view.
protected void	selectImpl(IlvDashboardSymbol symbol) Sets the keyboard selection to symbol.
void	selectNext() Select the next symbol in the selection chain.
void	selectPrevious() Selects the previous selectable symbol in the selection chain.
protected void	unselect(IlvDashboardSymbol symbol) Removes the selection from symbol.
void	updateSelectionChain() Updates the selection chain.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IlvDashboardKeySelectManager

public IlvDashboardKeySelectManager(IlvDashboardDiagram diagram)

Constructs an IlvDashboardKeySelectManager object to be used with diagram

Parameters:

diagram - A dashboard diagram that will react to key selection events.

Method Detail

updateSelectionChain

public void updateSelectionChain()

Updates the selection chain. Call this method if the user has inserted, removed, or moved symbols in the Dashboard Diagram.

select

public void select(IlvDashboardSymbol symbol)

Selects a IlvDashboardSymbol in a dashboard diagram in response to a keyboard event.

Parameters:

symbol - The symbol to be selected.

getSelected

public IlvDashboardSymbol getSelected()

Returns the currently selected symbol in the dashboard diagram.

Returns:

The currently selected symbol in the dashboard diagram.

removeSelectableSymbol

public void removeSelectableSymbol(IlvDashboardSymbol symbol)

Removes symbol from the selectable symbol chain.

Parameters:

symbol - The Dashboard Symbol to be removed.

selectNext

public void selectNext()

Select the next symbol in the selection chain.

selectPrevious

public void selectPrevious()

Selects the previous selectable symbol in the selection chain.

selectAt

public void selectAt(double x,
                     double y,
                     IlvManagerView view)

Selects the object located at the (x,y) coordinate in view.

Note: if there is no selectable symbol at the specified location, this method does nothing.

Parameters:

x - The x coordinate.

y - The y coordinate.

view - The view of the attached dashboard diagram.

focusGained

public void focusGained()

Call focusGained() when the dashboard diagram attached to this selector gains the focus.

focusLost

public void focusLost()

Call focusLost() when the dashboard diagram attached to this selector gains the focus.

See Also:

focusGained()

isSelectable

protected boolean isSelectable(IlvDashboardSymbol symbol)

Tests if the symbol is selectable. The default implementation returns true for any symbol that is not a link.

Parameters:

symbol - A symbol in the dashboard diagram attached to this IlvDashboardKeySelectManager instance.

Returns:

true if symbol can be selected.

insertSelectableSymbol

protected void insertSelectableSymbol(IlvDashboardSymbol symbol)

Inserts a selectable symbol into the selection chain. The default implementation invokes isAfter(IlvDashboardSymbol, IlvDashboardSymbol) to determine its position in the selection order.

Parameters:

symbol - the selectable symbol to be inserted into the selection chain.

isAfter

protected boolean isAfter(IlvDashboardSymbol symbol,
                          IlvDashboardSymbol reference)

Compares the selection chain order for two symbols.

Parameters:

symbol - The symbol to be compared with a reference symbol.

reference - The reference symbol to which symbol is compared.

Returns:

true if symbol will gain keyboard selection after reference

unselect

protected void unselect(IlvDashboardSymbol symbol)

Removes the selection from symbol.

Parameters:

symbol - The symbol that has lost keyboard selection.

selectImpl

protected void selectImpl(IlvDashboardSymbol symbol)

Sets the keyboard selection to symbol.

Parameters:

symbol - The symbol that has keyboard selection.