ilog.views.dashboard

Class IlvDashboardInteractor

java.lang.Object

ilog.views.IlvManagerViewInteractor

ilog.views.dashboard.IlvDashboardInteractor

All Implemented Interfaces:

Serializable

public class IlvDashboardInteractor
extends IlvManagerViewInteractor

IlvDashboardInteractor is a subclassed manager view interactor that processes IlvDashboardDiagram events.

Overview

This class manages the following:

• target dashboard URLs attached to IlvDashboardSymbol objects
• the selection of an active symbol
• dispatching symbol interactor events

When a user passes the mouse over a symbol that has an attached target URL, the cursor is changed to show that. When the symbol is clicked, a dashboard diagram displaying the contents of the attached URL is opened in a new window.

If an IlvDashboardKeySelectManager is attached to the dashboard diagram, this interactor invokes the applicable focus selection functions that follow the mouse click or arrow key events it receives.

Example

To use this interactor with a dashboard diagram, create an IlvDashboardInteractor 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());
   // To manage the keyboard focus-like selection
    dashboard.setSelectManager(new IlvDashboardKeySelectManager(dashboard));
   ...
   }
 

Since:

JViews 8.0

See Also:

IlvDiagrammer.getView(), IlvDashboardSymbol.getTargetDashboardURL(), IlvDashboardDiagram.setSelectManager(IlvDashboardKeySelectManager), IlvDashboardKeySelectManager, Serialized Form

Constructor Summary

Constructors

Constructor and Description
IlvDashboardInteractor() Constructs a dashboard interactor.

Method Summary

Modifier and Type	Method and Description
protected void	attach(IlvManagerView v) Sets the mouse cursor and adds a listener to the view added to this IlvDashboardInteractor instance.
protected void	detach() Sets the mouse cursor and removes the listener added to this IlvDashboardInteractor instance.
IlvDashboardDiagram	getDiagram() Returns the dashboard diagram attached to this interactor.
protected void	processEvent(AWTEvent evt) Handles navigation and focus events by selecting the symbol clicked or moving the focus to the next symbol when keyboard navigation arrows are pressed.
protected void	processFocusEvent(FocusEvent event) Call this method when the dashboard diagram attached to this selector gains the focus.
protected boolean	processFocusKeyEvent(KeyEvent event) Selects the next symbol in the selection chain in function of the key pressed by the user.
protected void	processMouseEvent(MouseEvent event) Processes a mouse event by setting the focus on the dashboard diagram selected by the user or opening a window displaying a dashboard diagram linked to the symbol clicked by the user.
protected void	showDashboard(String urlString) Opens a window that displays the dashboard diagram read from a dashboard file.

Methods inherited from class ilog.views.IlvManagerViewInteractor

addFocusListener, addKeyListener, addMouseListener, addMouseMotionListener, allowEnsureVisible, allowEnsureVisible, disableEvents, drawGhost, drawGhost, enableEvents, ensureVisible, ensureVisible, getManager, getManagerView, getTransformer, handleExpose, isXORGhost, processKeyEvent, processMouseMotionEvent, removeFocusListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, setXORGhost

Methods inherited from class java.lang.Object

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

Constructor Detail

IlvDashboardInteractor

public IlvDashboardInteractor()

Constructs a dashboard interactor.

See Also:

How to use a IlvDashboardInteractor, The IlvDashboardInteractor overview.

Method Detail

getDiagram

public IlvDashboardDiagram getDiagram()

Returns the dashboard diagram attached to this interactor.

Returns:

The dashboard diagram attached to this interactor.

See Also:

The IlvDashboardInteractor overview., How to use a IlvDashboardInteractor

attach

protected void attach(IlvManagerView v)

Sets the mouse cursor and adds a listener to the view added to this IlvDashboardInteractor instance.

Overrides:

attach in class IlvManagerViewInteractor

Parameters:

v - The view added to this IlvDashboardInteractor instance.

See Also:

detach()

detach

protected void detach()

Sets the mouse cursor and removes the listener added to this IlvDashboardInteractor instance.

Overrides:

detach in class IlvManagerViewInteractor

See Also:

attach(IlvManagerView)

processEvent

protected void processEvent(AWTEvent evt)

Handles navigation and focus events by selecting the symbol clicked or moving the focus to the next symbol when keyboard navigation arrows are pressed. Mouse and keyboard events are dispatched to this function using internal listeners. After changing the mouse cursor, mouse events are dispatched to the interactor attached to the current symbol. An interactor is an event handler build into a symbol using Symbol Editor.

Overrides:

processEvent in class IlvManagerViewInteractor

Parameters:

evt - The mouse or keyboard event to be handled.

See Also:

processFocusKeyEvent(KeyEvent)

processFocusKeyEvent

protected boolean processFocusKeyEvent(KeyEvent event)

Selects the next symbol in the selection chain in function of the key pressed by the user.

Pressing the UP or RIGHT key selects the next symbol, pressing the DOWN or LEFT key selects the previous symbol in the selection chain.

Parameters:

event - The keyboard event to be handled.

Returns:

true if the event is processed by this function.

See Also:

processEvent(AWTEvent)

processFocusEvent

protected void processFocusEvent(FocusEvent event)

Call this method when the dashboard diagram attached to this selector gains the focus.

Overrides:

processFocusEvent in class IlvManagerViewInteractor

Parameters:

event - The mouse event to be handled.

See Also:

processEvent(AWTEvent), processFocusKeyEvent(KeyEvent), processMouseEvent(MouseEvent)

processMouseEvent

protected void processMouseEvent(MouseEvent event)

Processes a mouse event by setting the focus on the dashboard diagram selected by the user or opening a window displaying a dashboard diagram linked to the symbol clicked by the user. Other events are passed to IlvManagerViewInteractor.

Overrides:

processMouseEvent in class IlvManagerViewInteractor

Parameters:

event - The mouse event to be handled.

See Also:

IlvDashboardKeySelectManager, showDashboard(String), IlvManagerViewInteractor

showDashboard

protected void showDashboard(String urlString)

Opens a window that displays the dashboard diagram read from a dashboard file. This method opens the dashboard diagram from the file referenced by urlString. This dashboard diagram is displayed in a Swing JFrame component. If the given urlString null or a blank string, this method does nothing.

Parameters:

urlString - A URL pointing to a dashboard diagram file.