net.ontopia.topicmaps.viz
Interface ApplicationContextIF

All Known Implementing Classes:

AppletContext, ApplicationContext, DesktopContext

public interface ApplicationContextIF

EXPERIMENTAL: Interface to define the application context.

Method Summary

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 locator, TopicMapIF aTopicmap) Returns the topic with the given subject identifier, if any.
TypesConfigFrame	getTopicFrame() Display the configuration frame for topics
void	goToTopic(TopicIF aTopic) 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(java.lang.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.
void	setTmConfig(VizTopicMapConfigurationManager config) Store the TopicMapConfiguration
void	setView(TopicMapView view) Set the view
void	setVizPanel(VizPanel panel) Store the panel containing the map

Method Detail

getMaxLocality

int getMaxLocality()

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

getAssocFrame

TypesConfigFrame getAssocFrame()

Display the configuration frame for associations (edges)

Returns:

The association configuration frame

getTopicFrame

TypesConfigFrame getTopicFrame()

Display the configuration frame for topics

Returns:

the topic configuration frame

getDefaultLocality

int getDefaultLocality()

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

Returns:

the default locality

isApplet

boolean isApplet()

Is this an applet?

Returns:

boolean indicating if this context is an applet

goToTopic

void goToTopic(TopicIF aTopic)

Set the focus of the map to the specified topic

Parameters:

aTopic - Topic to set as the central focus

openPropertiesURL

void openPropertiesURL(java.lang.String aUrl)

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

void setStartTopic(TopicIF aTopic)

Assign the starting topic of the map to display.

Parameters:

aTopic - Start Topic

getTopicForLocator

TopicIF getTopicForLocator(LocatorIF locator,
                           TopicMapIF aTopicmap)

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

Parameters:

locator - the subject identifier

aTopicmap - the topic map to look up in

Returns:

topic with given subject identifier (or null if none)

loadTopic

void loadTopic(TopicIF aTopic)

Get a topic from the associated store

Parameters:

aTopic - to read from the store

focusNode

void focusNode(TMAbstractNode aNode)

Set the node as the focus of the map

Parameters:

aNode - node to focus on

setScopingTopic

void setScopingTopic(TopicIF aScope)

Set the scoping topic for the map

Parameters:

aScope - topic to set scope

getDefaultScopingTopic

TopicIF getDefaultScopingTopic(TopicMapIF aTopicmap)

Get the default scoping topic

Parameters:

aTopicmap - map that contains the topic

Returns:

default scoping topic

getStartTopic

TopicIF getStartTopic(TopicMapIF aTopicmap)

Return the start topic defined on the map

Parameters:

aTopicmap - map containing topic

Returns:

start topic

getEnabledItemIds

ParsedMenuFile getEnabledItemIds()

Return the menu of enabled items

Returns:

menu containing enabled items

setVizPanel

void setVizPanel(VizPanel panel)

Store the panel containing the map

Parameters:

panel - to save

setTmConfig

void setTmConfig(VizTopicMapConfigurationManager config)

Store the TopicMapConfiguration

Parameters:

config - to save

setView

void setView(TopicMapView view)

Set the view

Parameters:

view - to set