net.ontopia.topicmaps.viz

Class DesktopContext

java.lang.Object

net.ontopia.topicmaps.viz.ApplicationContext

net.ontopia.topicmaps.viz.DesktopContext

All Implemented Interfaces:

ApplicationContextIF

public class DesktopContext
extends ApplicationContext

EXPERIMENTAL: Information for the VizDesktop version of Vizigator

Constructor Summary

Constructors

Constructor and Description
DesktopContext(VizDesktop aDesktop)

Method Summary

Modifier and Type	Method and Description
void	focusNode(TMAbstractNode aNode) Set the node as the focus of the map
TypesConfigFrame	getAssocFrame() Display the configuration frame for associations (edges)
int	getDefaultLocality() Get the default locality for the application.
TopicIF	getDefaultScopingTopic(TopicMapIF aTopicmap) Get the default scoping topic
ParsedMenuFile	getEnabledItemIds() Return the menu of enabled items
int	getMaxLocality() Returns the maximum number of nodes (locality) to display linked to the central node.
TopicIF	getStartTopic(TopicMapIF aTopicmap) Return the start topic defined on the map
TopicIF	getTopicForLocator(LocatorIF aLocator, TopicMapIF topicmap) Returns the topic with the given subject identifier, if any.
TypesConfigFrame	getTopicFrame() Display the configuration frame for topics
void	goToTopic(TopicIF topic) Set the focus of the map to the specified topic
boolean	isApplet() Is this an applet?
void	loadTopic(TopicIF aTopic) Get a topic from the associated store
void	openPropertiesURL(String aUrl) Opens the supplied url string in a browser window.
void	setScopingTopic(TopicIF aScope) Set the scoping topic for the map
void	setStartTopic(TopicIF aTopic) Assign the starting topic of the map to display.

Methods inherited from class net.ontopia.topicmaps.viz.ApplicationContext

getTmConfig, getView, getVizPanel, setTmConfig, setView, setVizPanel

Methods inherited from class java.lang.Object

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

Constructor Detail

DesktopContext

public DesktopContext(VizDesktop aDesktop)

Method Detail

goToTopic

public void goToTopic(TopicIF topic)

Description copied from interface: ApplicationContextIF

Set the focus of the map to the specified topic

Parameters:

topic - Topic to set as the central focus

isApplet

public boolean isApplet()

Description copied from interface: ApplicationContextIF

Is this an applet?

Returns:

boolean indicating if this context is an applet

openPropertiesURL

public void openPropertiesURL(String aUrl)

Description copied from interface: ApplicationContextIF

Opens the supplied url string in a browser window. Which window is used is defined by the 'propTarget' applet parameter. Does nothing for non applet context.

Parameters:

aUrl - String representing the target url

setStartTopic

public void setStartTopic(TopicIF aTopic)

Description copied from interface: ApplicationContextIF

Assign the starting topic of the map to display.

Parameters:

aTopic - Start Topic

getTopicForLocator

public TopicIF getTopicForLocator(LocatorIF aLocator,
                                  TopicMapIF topicmap)

Description copied from interface: ApplicationContextIF

Returns the topic with the given subject identifier, if any.

Parameters:

aLocator - the subject identifier

topicmap - the topic map to look up in

Returns:

topic with given subject identifier (or null if none)

loadTopic

public void loadTopic(TopicIF aTopic)

Description copied from interface: ApplicationContextIF

Get a topic from the associated store

Parameters:

aTopic - to read from the store

focusNode

public void focusNode(TMAbstractNode aNode)

Description copied from interface: ApplicationContextIF

Set the node as the focus of the map

Parameters:

aNode - node to focus on

setScopingTopic

public void setScopingTopic(TopicIF aScope)

Description copied from interface: ApplicationContextIF

Set the scoping topic for the map

Parameters:

aScope - topic to set scope

getDefaultScopingTopic

public TopicIF getDefaultScopingTopic(TopicMapIF aTopicmap)

Description copied from interface: ApplicationContextIF

Get the default scoping topic

Parameters:

aTopicmap - map that contains the topic

Returns:

default scoping topic

getStartTopic

public TopicIF getStartTopic(TopicMapIF aTopicmap)

Description copied from interface: ApplicationContextIF

Return the start topic defined on the map

Parameters:

aTopicmap - map containing topic

Returns:

start topic

getDefaultLocality

public int getDefaultLocality()

Description copied from interface: ApplicationContextIF

Get the default locality for the application. This is usually 1

Returns:

the default locality

getMaxLocality

public int getMaxLocality()

Description copied from interface: ApplicationContextIF

Returns the maximum number of nodes (locality) to display linked to the central node. Large numbers (> 3) can have a significant performance impact when used, especially for large maps

Returns:

the maximum allowed locality

getEnabledItemIds

public ParsedMenuFile getEnabledItemIds()

Description copied from interface: ApplicationContextIF

Return the menu of enabled items

Returns:

menu containing enabled items

getAssocFrame

public TypesConfigFrame getAssocFrame()

Description copied from interface: ApplicationContextIF

Display the configuration frame for associations (edges)

Returns:

The association configuration frame

getTopicFrame

public TypesConfigFrame getTopicFrame()

Description copied from interface: ApplicationContextIF

Display the configuration frame for topics

Returns:

the topic configuration frame