org.wandora.application.gui.topicpanels

Interface TopicPanel

All Superinterfaces:

TopicMapListener

All Known Implementing Classes:

CustomTopicPanel, DockingFramePanel, DropExtractor, GraphTopicPanel, LayerInfoPanel, ProcessingTopicPanel, QueryEditorTopicPanel, RTopicPanel, SearchTopicPanel, SketchGridPanel, TabbedTopicPanel, TraditionalTopicPanel, TreeMapTopicPanel, TreeTopicPanel, WebViewTopicPanel

public interface TopicPanel
extends TopicMapListener

TopicPanel is an UI element used to view and edit topic map structures such as topics and associations in Wandora. Wandora contains several different topic panels such as GraphTopicPanel and TraditionalTopicPanel, each implementing this interface.

Author:

akivela

Method Summary

Modifier and Type	Method and Description
boolean	applyChanges() Topic panel should store all pending changes immediately.
javax.swing.JPanel	getGui() Return the UI element for the topic panel.
javax.swing.Icon	getIcon() Return icon image of the topic panel.
java.lang.String	getName() Return name of the topic panel.
int	getOrder() Deprecated.
java.lang.String	getTitle() Return title of the topic panel.
Topic	getTopic() Return the active topic in topic panel.
LocatorHistory	getTopicHistory() A topic panel can store it's own topic history.
javax.swing.JMenu	getViewMenu()
java.lang.Object[]	getViewMenuStruct() Topic panel can provide a menu structure that Wandora views in UI.
javax.swing.JPopupMenu	getViewPopupMenu()
void	init() Initialize the TopicPanel.
boolean	noScroll() If this returns true, then the topic panel will not be wrapped inside a scroll pane.
void	open(Topic topic) Open a topic in the topic panel.
void	refresh() Request topic panel UI refresh.
void	stop() A topic panel should stop all threads and close all (shared) resources.
boolean	supportsOpenTopic() Does the topic panel support topic open? In other words can one call the open method with a topic.

Methods inherited from interface org.wandora.topicmap.TopicMapListener

associationChanged, associationPlayerChanged, associationRemoved, associationTypeChanged, topicBaseNameChanged, topicChanged, topicDataChanged, topicRemoved, topicSubjectIdentifierChanged, topicSubjectLocatorChanged, topicTypeChanged, topicVariantChanged

Method Detail

init

void init()

Initialize the TopicPanel. Called always before the topic panel is used

supportsOpenTopic

boolean supportsOpenTopic()

Does the topic panel support topic open? In other words can one call the open method with a topic.

open

void open(Topic topic)
   throws TopicMapException,
          OpenTopicNotSupportedException

Open a topic in the topic panel. Usually opening means that the topic is being visualized in some way.

Throws:

TopicMapException

OpenTopicNotSupportedException

stop

void stop()

A topic panel should stop all threads and close all (shared) resources. Stopping closes the topic panel too.

refresh

void refresh()
      throws TopicMapException

Request topic panel UI refresh. The topic panel should refresh it's content and trigger repaint.

Throws:

TopicMapException

applyChanges

boolean applyChanges()
              throws CancelledException,
                     TopicMapException

Topic panel should store all pending changes immediately. Especially topic and association changes are important and should be stored during applyChanges.

Throws:

CancelledException

TopicMapException

getGui

javax.swing.JPanel getGui()

Return the UI element for the topic panel. Wandora gets topic panel's UI element here.

getTopic

Topic getTopic()
        throws TopicMapException

Return the active topic in topic panel. Usually the returned topic is the same topic that was opened with open methed.

Throws:

TopicMapException

getName

java.lang.String getName()

Return name of the topic panel. Name is viewed in Wandora's UI.

getTitle

java.lang.String getTitle()

Return title of the topic panel. Name is viewed in the title bar of dockable.

getIcon

javax.swing.Icon getIcon()

Return icon image of the topic panel. Icon is viewed in Wandora's UI.

getOrder

int getOrder()

Deprecated.

Return integer number that specifies topic panel's order. Order is used to sort topic panel sets. Order number is not used anymore as available panels are read from options.xml and the order in options is the order Wandora views the panels.

getViewMenuStruct

java.lang.Object[] getViewMenuStruct()

Topic panel can provide a menu structure that Wandora views in UI. This method returns a plain object array of menu objects. Plain object array is transformed into a menu using UIBox.

getViewMenu

javax.swing.JMenu getViewMenu()

getViewPopupMenu

javax.swing.JPopupMenu getViewPopupMenu()

noScroll

boolean noScroll()

If this returns true, then the topic panel will not be wrapped inside a scroll pane. Useful if the panel provides its own scrolling.

getTopicHistory

LocatorHistory getTopicHistory()

A topic panel can store it's own topic history. Topic history is used to navigate backward and forward in Wandora. However, this is a hidden feature and has NOT been taken into production yet! Thus, Wandora doesn't support the topic panel specific topic histories yet!