org.wandora.application.gui.topicstringify

Interface TopicStringifier

All Known Implementing Classes:

DefaultTopicStringifier, TopicStringifierToVariant

public interface TopicStringifier

TopicStringifier interface specifies all methods required in a Java class that creates string representations out of topics. String representations are used in Wandora anytime a topic is viewed.

Author:

akivela

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Description is a text that describes the TopicStringifier.
javax.swing.Icon	getIcon() Method returns an icon shown in Wandora UI as a mark of the TopicStringifier.
boolean	initialize(Wandora wandora, Context context) Initialization method is called before a TopicStringifier is actually used.
void	stringIntoTopic(java.lang.String oldString, java.lang.String newString, Topic topic) Sometimes topic viewer may support string editing feature.
boolean	supportsStringIntoTopic() If topic viewer supports string editing feature and Wandora can push the string back into the topic, this method should return true.
java.lang.String	toString(Topic t) toString method is the actual endpoint used to create a string out of a topic.

Method Detail

initialize

boolean initialize(Wandora wandora,
                   Context context)

Initialization method is called before a TopicStringifier is actually used. If initialization returns false, the TopicStringifier should not be used.

toString

java.lang.String toString(Topic t)

toString method is the actual endpoint used to create a string out of a topic.

getDescription

java.lang.String getDescription()

Description is a text that describes the TopicStringifier. Text is shown in Wandora's UI whenever user wants more information about the TopicStringifier, for example, as a tooltip text.

getIcon

javax.swing.Icon getIcon()

Method returns an icon shown in Wandora UI as a mark of the TopicStringifier. Current Wandora views the icon in the infobar near topic's name.

stringIntoTopic

void stringIntoTopic(java.lang.String oldString,
                     java.lang.String newString,
                     Topic topic)
              throws TopicMapException

Sometimes topic viewer may support string editing feature. This method is used to push string back into a topic. String is stored into the topic.

Throws:

TopicMapException

supportsStringIntoTopic

boolean supportsStringIntoTopic()

If topic viewer supports string editing feature and Wandora can push the string back into the topic, this method should return true. If TopicStringifier can't push a string back into the topic, method should return false. The push is implemented in method stringIntoTopic.