IlvExpandCollapseInteractor (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.views.IlvManagerViewInteractor
- - ilog.views.interactor.IlvExpandCollapseInteractor

All Implemented Interfaces:

IlvPermanentInteractorInterface, Serializable
```
public class IlvExpandCollapseInteractor
extends IlvManagerViewInteractor
implements IlvPermanentInteractorInterface
```
This interactor allows you to click onto a submanager or a link bundle to expand or collapse the object.

Since:

JViews 8.8

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

IlvExpandCollapseInteractor()
Constructs an IlvExpandCollapseInteractor.

Constructors
Constructor and Description
`IlvExpandCollapseInteractor()` Constructs an `IlvExpandCollapseInteractor`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`attach(IlvManagerView view)` Called when the interactor is attached to the manager view.
`protected void`	`detach()` Called when the interactor is detached from the view.
`protected void`	`expandOrCollapse(IlvGraphic obj)` Expands or collapses the input object.
`Cursor`	`getCollapseCursor()` Returns the cursor to be displayed when the mouse is over any collapsable object.
`Cursor`	`getExpandCursor()` Returns the cursor to be displayed when the mouse is over any expandable object.
`Cursor`	`getIdleCursor()` Returns the cursor to be displayed when the mouse is not over any expandable or collapsable object.
`protected IlvGraphic`	`getObject(IlvPoint p)` Searches the expandable object under the mouse.
`protected boolean`	`handleButtonDown(MouseEvent event)` Processes the button down events.
`protected boolean`	`handleButtonUp(MouseEvent event)` Processes the button up events.
`boolean`	`isHandleLinkBundlesEnabled()` Returns whether the interactor can expand and collapse objects of type `IlvLinkBundle`.
`boolean`	`isHandleManagersEnabled()` Returns whether the interactor can expand and collapse objects of type `IlvManager`.
`boolean`	`isPermanent()` Returns `true` if the interactor operates in permanent mode; `false` otherwise.
`boolean`	`isShowSelection()` Returns whether selection is used to indicate which object is to be expanded or collapsed.
`protected void`	`processMouseEvent(MouseEvent event)` Processes the mouse events.
`protected void`	`processMouseMotionEvent(MouseEvent event)` Processes the mouse motion events.
`void`	`setCollapseCursor(Cursor cursor)` Sets the cursor to be displayed when the mouse is over any collapsable object.
`void`	`setExpandCursor(Cursor cursor)` Sets the cursor to be displayed when the mouse is over any expandable object.
`void`	`setHandleLinkBundlesEnabled(boolean enable)` Sets whether the interactor can expand and collapse objects of type `IlvLinkBundle`.
`void`	`setHandleManagersEnabled(boolean enable)` Sets whether the interactor can expand and collapse objects of type `IlvManager`.
`void`	`setIdleCursor(Cursor cursor)` Sets the cursor to be displayed when the mouse is not over any expandable or collapsable object.
`void`	`setPermanent(boolean set)` Changes the mode of the interactor.
`void`	`setShowSelection(boolean set)` Sets whether selection is used to indicate which object is to be expanded or collapsed.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IlvExpandCollapseInteractor
```
public IlvExpandCollapseInteractor()
```
    Constructs an IlvExpandCollapseInteractor.
- Method Detail
  - attach
```
protected void attach(IlvManagerView view)
```
    Called when the interactor is attached to the manager view.
    
    Overrides:
    
    attach in class IlvManagerViewInteractor
    
    Parameters:
    
    view - The manager view.
    
    See Also:
    
    IlvManagerViewInteractor.detach()
  - detach
```
protected void detach()
```
    Called when the interactor is detached from the view.
    
    Overrides:
    
    detach in class IlvManagerViewInteractor
    
    See Also:
    
    IlvManagerViewInteractor.attach(ilog.views.IlvManagerView)
  - setHandleManagersEnabled
```
public void setHandleManagersEnabled(boolean enable)
```
    Sets whether the interactor can expand and collapse objects of type IlvManager.
  - isHandleManagersEnabled
```
public boolean isHandleManagersEnabled()
```
    Returns whether the interactor can expand and collapse objects of type IlvManager.
  - setHandleLinkBundlesEnabled
```
public void setHandleLinkBundlesEnabled(boolean enable)
```
    Sets whether the interactor can expand and collapse objects of type IlvLinkBundle.
  - isHandleLinkBundlesEnabled
```
public boolean isHandleLinkBundlesEnabled()
```
    Returns whether the interactor can expand and collapse objects of type IlvLinkBundle.
  - setIdleCursor
```
public void setIdleCursor(Cursor cursor)
```
    Sets the cursor to be displayed when the mouse is not over any expandable or collapsable object.
  - getIdleCursor
```
public Cursor getIdleCursor()
```
    Returns the cursor to be displayed when the mouse is not over any expandable or collapsable object.
  - setExpandCursor
```
public void setExpandCursor(Cursor cursor)
```
    Sets the cursor to be displayed when the mouse is over any expandable object.
  - getExpandCursor
```
public Cursor getExpandCursor()
```
    Returns the cursor to be displayed when the mouse is over any expandable object.
  - setCollapseCursor
```
public void setCollapseCursor(Cursor cursor)
```
    Sets the cursor to be displayed when the mouse is over any collapsable object.
  - getCollapseCursor
```
public Cursor getCollapseCursor()
```
    Returns the cursor to be displayed when the mouse is over any collapsable object.
  - setShowSelection
```
public void setShowSelection(boolean set)
```
    Sets whether selection is used to indicate which object is to be expanded or collapsed.
  - isShowSelection
```
public boolean isShowSelection()
```
    Returns whether selection is used to indicate which object is to be expanded or collapsed.
  - setPermanent
```
public void setPermanent(boolean set)
```
    Changes the mode of the interactor.
    
    Specified by:
    
    setPermanent in interface IlvPermanentInteractorInterface
    
    Parameters:
    
    set - The new mode.
    
    See Also:
    
    isPermanent()
  - isPermanent
```
public boolean isPermanent()
```
    Returns true if the interactor operates in permanent mode; false otherwise.
    
    Specified by:
    
    isPermanent in interface IlvPermanentInteractorInterface
    
    See Also:
    
    setPermanent(boolean)
  - processMouseEvent
```
protected void processMouseEvent(MouseEvent event)
```
    Processes the mouse events.
    
    Overrides:
    
    processMouseEvent in class IlvManagerViewInteractor
    
    Parameters:
    
    event - The event.
    
    See Also:
    
    IlvManagerViewInteractor.addMouseListener(java.awt.event.MouseListener)
  - handleButtonDown
```
protected boolean handleButtonDown(MouseEvent event)
```
    Processes the button down events.
    
    Parameters:
    
    event - The event.
    
    Returns:
    
    true if the event has been processed, false otherwise.
  - handleButtonUp
```
protected boolean handleButtonUp(MouseEvent event)
```
    Processes the button up events.
    
    Parameters:
    
    event - The event.
    
    Returns:
    
    true if the event has been processed, false otherwise.
  - expandOrCollapse
```
protected void expandOrCollapse(IlvGraphic obj)
```
    Expands or collapses the input object.
    
    Parameters:
    
    obj - The manager or link bundle.
  - processMouseMotionEvent
```
protected void processMouseMotionEvent(MouseEvent event)
```
    Processes the mouse motion events.
    
    Overrides:
    
    processMouseMotionEvent in class IlvManagerViewInteractor
    
    Parameters:
    
    event - The event.
    
    See Also:
    
    IlvManagerViewInteractor.addMouseMotionListener(java.awt.event.MouseMotionListener)
  - getObject
```
protected IlvGraphic getObject(IlvPoint p)
```
    Searches the expandable object under the mouse. It searches only for visible and selectable objects.
    
    Parameters:
    
    p - The point in view coordinates
    
    Returns:
    
    The manager or link bundle at the given point.

Class IlvExpandCollapseInteractor

Constructor Summary

Method Summary

Methods inherited from class ilog.views.IlvManagerViewInteractor

Methods inherited from class java.lang.Object

Constructor Detail

IlvExpandCollapseInteractor

Method Detail

attach

detach

setHandleManagersEnabled

isHandleManagersEnabled

setHandleLinkBundlesEnabled

isHandleLinkBundlesEnabled

setIdleCursor

getIdleCursor

setExpandCursor

getExpandCursor

setCollapseCursor

getCollapseCursor

setShowSelection

isShowSelection

setPermanent

isPermanent

processMouseEvent

handleButtonDown

handleButtonUp

expandOrCollapse

processMouseMotionEvent

getObject