Module org.icepdf.ri.viewer

Package org.icepdf.ri.common.utility.outline

Class OutlinesController

java.lang.Object

java.awt.event.MouseAdapter

org.icepdf.ri.common.utility.outline.OutlinesController

All Implemented Interfaces:

MouseListener, MouseMotionListener, MouseWheelListener, EventListener, TreeExpansionListener, TreeModelListener, TreeSelectionListener

public class OutlinesController
extends MouseAdapter
implements TreeModelListener, TreeSelectionListener, TreeExpansionListener

The OutlinesController class is responsible for managing the Outlines (Bookmarks) JTree. When editing is enabled a user can drag and drop outline items to new locations in the tree as well as editing the title of the outline item. Expansion state will also be updated when the tree is expanded or collapsed. Changes will persist when the document is saved.

Constructor Summary

Constructors

Constructor	Description
OutlinesController(SwingController controller, JTree outlinesTree)

Method Summary

Modifier and Type	Method	Description
void	dispose()	Disposes controller clearing resources.
void	followOutlineItem(OutlineItemTreeNode node)
void	insertNewOutline()
static boolean	isOutlineEditingEnabled()	Returns true if outline editing is enabled.
void	mouseClicked(MouseEvent mouseEvent)
void	setEditable(boolean editable)
void	treeCollapsed(TreeExpansionEvent treeExpansionEvent)
void	treeExpanded(TreeExpansionEvent treeExpansionEvent)
void	treeNodesChanged(TreeModelEvent treeModelEvent)
void	treeNodesInserted(TreeModelEvent treeModelEvent)
void	treeNodesRemoved(TreeModelEvent treeModelEvent)
void	treeStructureChanged(TreeModelEvent treeModelEvent)
void	updateOutlineItemState(OutlineItemTreeNode parentNode)
void	valueChanged(TreeSelectionEvent e)

Methods inherited from class java.awt.event.MouseAdapter

mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved

Methods inherited from class java.lang.Object

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

Constructor Detail

OutlinesController

public OutlinesController(SwingController controller,
                          JTree outlinesTree)

Method Detail

insertNewOutline

public void insertNewOutline()
                      throws InterruptedException

Throws:

InterruptedException

updateOutlineItemState

public void updateOutlineItemState(OutlineItemTreeNode parentNode)

setEditable

public void setEditable(boolean editable)

isOutlineEditingEnabled

public static boolean isOutlineEditingEnabled()

Returns true if outline editing is enabled. The returned value is controlled by the state of the system property org.icepdf.viewer.outlineEdit.enabled.

Returns:

true if enabled, false otherwise.

mouseClicked

public void mouseClicked(MouseEvent mouseEvent)

Specified by:

mouseClicked in interface MouseListener

Overrides:

mouseClicked in class MouseAdapter

treeExpanded

public void treeExpanded(TreeExpansionEvent treeExpansionEvent)

Specified by:

treeExpanded in interface TreeExpansionListener

treeCollapsed

public void treeCollapsed(TreeExpansionEvent treeExpansionEvent)

Specified by:

treeCollapsed in interface TreeExpansionListener

treeNodesInserted

public void treeNodesInserted(TreeModelEvent treeModelEvent)

Specified by:

treeNodesInserted in interface TreeModelListener

treeNodesRemoved

public void treeNodesRemoved(TreeModelEvent treeModelEvent)

Specified by:

treeNodesRemoved in interface TreeModelListener

treeNodesChanged

public void treeNodesChanged(TreeModelEvent treeModelEvent)

Specified by:

treeNodesChanged in interface TreeModelListener

treeStructureChanged

public void treeStructureChanged(TreeModelEvent treeModelEvent)

Specified by:

treeStructureChanged in interface TreeModelListener

followOutlineItem

public void followOutlineItem(OutlineItemTreeNode node)

dispose

public void dispose()

Disposes controller clearing resources.

valueChanged

public void valueChanged(TreeSelectionEvent e)

Specified by:

valueChanged in interface TreeSelectionListener