oracle.dss.dataView
Interface TokenSubstitution

All Superinterfaces:

BaseTokenSubstitution

All Known Implementing Classes:

TokenSubstitutionAdapter

public interface TokenSubstitution
extends BaseTokenSubstitution

This interface is defined in context with the Insert tab in the UI panels. It defines methods that allow you to substitute text for a token in a String.

To use this interface, you must create four strings for each token that will be replaced by text:

• ListItem - Localizable String that is displayed in the insert drop down list, such as "Date". Store all of these in an array. The UI will ask for the array.
• Token - Localizable String, such as "&Date", that appears in the JTextField when a user has selected a ListItem.
• Key - String that is actually stored in the unparsed String; this String must not be localized, because it needs to be same String in all languages.
• Parsed string - The String that is displayed in the view itself, such as "24 March 2001".

In addition, you must provide conversion between these strings, which are used as follows:

1. The UI asks you for the array of ListItem strings, so that it knows how to display the Insert drop down list box.
2. When the end user selects one of the list items, the UI gets the selected ListItem, passes it to you, and asks you for the token to display in the JTextField.
3. The UI inserts the token into the JTextField.
4. The UI gives you the String from the JTextField, including the token, and asks you for a String that has the key instead of the token.
5. The UI gives you the String with the key, to ask you for the parsed String to display in the graph.

When a graph is persisted, the String with key is stored in the XML, and this String is given to your implementation of this interface to restore the parsed String in the graph.

Method Summary

Methods inherited from interface oracle.dss.util.BaseTokenSubstitution

getKey, getKeyString, getListItems, getParsedString, getToken, getTokenString, setLocale