org.wandora.application.gui.topicpanels

Class WebViewTopicPanel

java.lang.Object

org.wandora.application.gui.topicpanels.WebViewTopicPanel

All Implemented Interfaces:

TopicPanel, TopicMapListener

public class WebViewTopicPanel
extends java.lang.Object
implements TopicPanel

Author:

akivela

Field Summary

Fields

Modifier and Type	Field and Description
private Topic	currentTopic
private WebViewPanel	webPanel

Constructor Summary

Constructors

Constructor and Description
WebViewTopicPanel()

Method Summary

Modifier and Type	Method and Description
boolean	applyChanges() Topic panel should store all pending changes immediately.
void	associationChanged(Association a) A notification used to report general or large changes in association.
void	associationPlayerChanged(Association a, Topic role, Topic newPlayer, Topic oldPlayer) A notification that a player in an association with a certain role has been changed.
void	associationRemoved(Association a) A notification that an association has been completely removed.
void	associationTypeChanged(Association a, Topic newType, Topic oldType) A notification that association type has changed.
java.lang.Object	executeJavascript(java.lang.String script)
private javax.swing.JPanel	getErrorPanel()
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() Return integer number that specifies topic panel's order.
java.lang.String	getSelectedText()
java.lang.String	getSource()
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()
javafx.scene.web.WebEngine	getWebEngine()
java.lang.String	getWebLocation()
java.lang.String	getWebTitle()
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.
void	topicBaseNameChanged(Topic t, java.lang.String newName, java.lang.String oldName) Notification that the base name has been changed.
void	topicChanged(Topic t) A notification used to report general or large changes in topic, for example when topics are merged.
void	topicDataChanged(Topic t, Topic type, Topic version, java.lang.String newValue, java.lang.String oldValue) Notification that topic occurrence has been changed.
void	topicRemoved(Topic t) Notification that a topic has been completely removed.
void	topicSubjectIdentifierChanged(Topic t, Locator added, Locator removed) Notification that a subject identifier has changed.
void	topicSubjectLocatorChanged(Topic t, Locator newLocator, Locator oldLocator) Notification that the subject locator has been changed.
void	topicTypeChanged(Topic t, Topic added, Topic removed) Notification that a topic type has changed.
void	topicVariantChanged(Topic t, java.util.Collection<Topic> scope, java.lang.String newName, java.lang.String oldName) Notification that a variant name has been changed.

Methods inherited from class java.lang.Object

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

Field Detail

currentTopic

private Topic currentTopic

webPanel

private WebViewPanel webPanel

Constructor Detail

WebViewTopicPanel

public WebViewTopicPanel()

Method Detail

init

public void init()

Description copied from interface: TopicPanel

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

Specified by:

init in interface TopicPanel

supportsOpenTopic

public boolean supportsOpenTopic()

Description copied from interface: TopicPanel

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

Specified by:

supportsOpenTopic in interface TopicPanel

open

public void open(Topic topic)
          throws TopicMapException

Description copied from interface: TopicPanel

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

Specified by:

open in interface TopicPanel

Throws:

TopicMapException

stop

public void stop()

Description copied from interface: TopicPanel

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

Specified by:

stop in interface TopicPanel

refresh

public void refresh()
             throws TopicMapException

Description copied from interface: TopicPanel

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

Specified by:

refresh in interface TopicPanel

Throws:

TopicMapException

applyChanges

public boolean applyChanges()
                     throws CancelledException,
                            TopicMapException

Description copied from interface: TopicPanel

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

Specified by:

applyChanges in interface TopicPanel

Throws:

CancelledException

TopicMapException

getGui

public javax.swing.JPanel getGui()

Description copied from interface: TopicPanel

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

Specified by:

getGui in interface TopicPanel

getErrorPanel

private javax.swing.JPanel getErrorPanel()

getTopic

public Topic getTopic()
               throws TopicMapException

Description copied from interface: TopicPanel

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

Specified by:

getTopic in interface TopicPanel

Throws:

TopicMapException

getName

public java.lang.String getName()

Description copied from interface: TopicPanel

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

Specified by:

getName in interface TopicPanel

getTitle

public java.lang.String getTitle()

Description copied from interface: TopicPanel

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

Specified by:

getTitle in interface TopicPanel

getIcon

public javax.swing.Icon getIcon()

Description copied from interface: TopicPanel

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

Specified by:

getIcon in interface TopicPanel

getOrder

public int getOrder()

Description copied from interface: TopicPanel

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.

Specified by:

getOrder in interface TopicPanel

getViewMenuStruct

public java.lang.Object[] getViewMenuStruct()

Description copied from interface: TopicPanel

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.

Specified by:

getViewMenuStruct in interface TopicPanel

getViewMenu

public javax.swing.JMenu getViewMenu()

Specified by:

getViewMenu in interface TopicPanel

getViewPopupMenu

public javax.swing.JPopupMenu getViewPopupMenu()

Specified by:

getViewPopupMenu in interface TopicPanel

getTopicHistory

public LocatorHistory getTopicHistory()

Description copied from interface: TopicPanel

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!

Specified by:

getTopicHistory in interface TopicPanel

noScroll

public boolean noScroll()

Description copied from interface: TopicPanel

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

Specified by:

noScroll in interface TopicPanel

getWebEngine

public javafx.scene.web.WebEngine getWebEngine()

getWebLocation

public java.lang.String getWebLocation()

getSource

public java.lang.String getSource()

getSelectedText

public java.lang.String getSelectedText()

getWebTitle

public java.lang.String getWebTitle()

executeJavascript

public java.lang.Object executeJavascript(java.lang.String script)

topicSubjectIdentifierChanged

public void topicSubjectIdentifierChanged(Topic t,
                                          Locator added,
                                          Locator removed)
                                   throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a subject identifier has changed. Either added or removed is non-null and indicates that a subject identifier has been added or removed, respectively. The non-null parameter contains the new subject identifier or the removed subject identifier.

Specified by:

topicSubjectIdentifierChanged in interface TopicMapListener

Throws:

TopicMapException

topicBaseNameChanged

public void topicBaseNameChanged(Topic t,
                                 java.lang.String newName,
                                 java.lang.String oldName)
                          throws TopicMapException

Description copied from interface: TopicMapListener

Notification that the base name has been changed. Either newName or oldName may be null indicating that base name was removed or old name was empty.

Specified by:

topicBaseNameChanged in interface TopicMapListener

Throws:

TopicMapException

topicTypeChanged

public void topicTypeChanged(Topic t,
                             Topic added,
                             Topic removed)
                      throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a topic type has changed. Either added or removed is non-null and indicates that a type has been added or removed, respectively. The non-null parameter contains the new type or the removed type.

Specified by:

topicTypeChanged in interface TopicMapListener

Throws:

TopicMapException

topicVariantChanged

public void topicVariantChanged(Topic t,
                                java.util.Collection<Topic> scope,
                                java.lang.String newName,
                                java.lang.String oldName)
                         throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a variant name has been changed. Either newName or oldName may be null indicating that the variant name was removed or old name was empty.

Specified by:

topicVariantChanged in interface TopicMapListener

Throws:

TopicMapException

topicDataChanged

public void topicDataChanged(Topic t,
                             Topic type,
                             Topic version,
                             java.lang.String newValue,
                             java.lang.String oldValue)
                      throws TopicMapException

Description copied from interface: TopicMapListener

Notification that topic occurrence has been changed. Either newValue or oldValue may be null indicating that the occurrence was removed or old value was empty.

Specified by:

topicDataChanged in interface TopicMapListener

Throws:

TopicMapException

topicSubjectLocatorChanged

public void topicSubjectLocatorChanged(Topic t,
                                       Locator newLocator,
                                       Locator oldLocator)
                                throws TopicMapException

Description copied from interface: TopicMapListener

Notification that the subject locator has been changed. Either newLocator or oldLocator may be null indicating that locator was removed or there was no old locator.

Specified by:

topicSubjectLocatorChanged in interface TopicMapListener

Throws:

TopicMapException

topicRemoved

public void topicRemoved(Topic t)
                  throws TopicMapException

Description copied from interface: TopicMapListener

Notification that a topic has been completely removed.

Specified by:

topicRemoved in interface TopicMapListener

Throws:

TopicMapException

topicChanged

public void topicChanged(Topic t)
                  throws TopicMapException

Description copied from interface: TopicMapListener

A notification used to report general or large changes in topic, for example when topics are merged. Such a large change may consist of any number of smaller changes that are NOT reported individually with the other listener methods. This method is used when tracking individual changes is hard to implement.

Specified by:

topicChanged in interface TopicMapListener

Throws:

TopicMapException

associationTypeChanged

public void associationTypeChanged(Association a,
                                   Topic newType,
                                   Topic oldType)
                            throws TopicMapException

Description copied from interface: TopicMapListener

A notification that association type has changed. Either newType or oldType can be null to indicate that old or new type was null. When type is changed from one topic to another, both will be non-null.

Specified by:

associationTypeChanged in interface TopicMapListener

Throws:

TopicMapException

associationPlayerChanged

public void associationPlayerChanged(Association a,
                                     Topic role,
                                     Topic newPlayer,
                                     Topic oldPlayer)
                              throws TopicMapException

Description copied from interface: TopicMapListener

A notification that a player in an association with a certain role has been changed. Either newPlayer or oldPlayer can be null to indicate that the no new player for the role was set or that there was no player with the role previously. Both can also be non-null to indicate that the player of the role changed.

Specified by:

associationPlayerChanged in interface TopicMapListener

Throws:

TopicMapException

associationRemoved

public void associationRemoved(Association a)
                        throws TopicMapException

Description copied from interface: TopicMapListener

A notification that an association has been completely removed.

Specified by:

associationRemoved in interface TopicMapListener

Throws:

TopicMapException

associationChanged

public void associationChanged(Association a)
                        throws TopicMapException

Description copied from interface: TopicMapListener

A notification used to report general or large changes in association. Such a large change may consist of any number of smaller changes that are NOT reported individually with the other listener methods. This method is used when tracking individual changes is hard to implement.

Specified by:

associationChanged in interface TopicMapListener

Throws:

TopicMapException