ro.sync.exml.workspace.api.editor.page.ditamap.keys
Class KeyDefinitionInfo

java.lang.Object
  ro.sync.exml.workspace.api.editor.page.ditamap.keys.KeyDefinitionInfo

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public class KeyDefinitionInfo
extends java.lang.Object

Information about a key definition. This is filled on the API side.

Since:

14

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Field Summary

static java.lang.String	DEFINITION_LOCATION The location of the DITA Map where the key definition was defined.
static java.lang.String	DESCRIPTION This could be the navigation title on the topic ref which defines the key.
static java.lang.String	HREF The relative href value of the topic ref which defines the key.
static java.lang.String	META_CONTENT_PROVIDER May return a MetaContentProvider implementation which returns the text which should appear on an element which has the keyref if the element has no content.
static java.lang.String	NAME The key name.

Constructor Summary

KeyDefinitionInfo()

Method Summary

java.lang.Object	getProperty(java.lang.String propertyName) Get the value of a recognized property.
void	setProperty(java.lang.String propertyName, java.lang.Object propertyValue) Get the value of a recognized property.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

The key name.

See Also:

Constant Field Values

HREF

public static final java.lang.String HREF

The relative href value of the topic ref which defines the key. Can be null. If the defined key points indirectly (using a keyref) to other definitions, it is the responsibility of the developer to set here the final href value. The absolute reference will be resolved based on the "DEFINITION_LOCATION" property which needs to be set in the KeyDefinitionInfo.

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

This could be the navigation title on the topic ref which defines the key. It is used for display purposes when a key reference is inserted. Can be null.

See Also:

Constant Field Values

DEFINITION_LOCATION

public static final java.lang.String DEFINITION_LOCATION

The location of the DITA Map where the key definition was defined. This must be given as an URL in the Oxygen standalone version. In the Oxygen plugin for Eclipse this can be also given as a native resource like IResource. The location is useful in order for Oxygen to determine the absolute location where the keyref is pointing. When the user clicks a keyref or a conkeyref in the Author page Oxygen has to open the target location corresponding to it.

See Also:

Constant Field Values

META_CONTENT_PROVIDER

public static final java.lang.String META_CONTENT_PROVIDER

May return a MetaContentProvider implementation which returns the text which should appear on an element which has the keyref if the element has no content. The provider is useful in order for Oxygen to show the static text in place in the Author page.

See Also:

Constant Field Values

Constructor Detail

KeyDefinitionInfo

public KeyDefinitionInfo()

Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String propertyName)

Get the value of a recognized property.

Parameters:

propertyName - The property name. One of the following constants:

• DESCRIPTION
• NAME
• HREF
• DEFINITION_LOCATION

Returns:

The property value or null if not available.

setProperty

public void setProperty(java.lang.String propertyName,
                        java.lang.Object propertyValue)
                 throws java.lang.IllegalArgumentException

Get the value of a recognized property.

Parameters:

propertyName - The property name. One of the following constants:

• DESCRIPTION
• NAME
• HREF
• DEFINITION_LOCATION

propertyValue - The value of the property.

Throws:

java.lang.IllegalArgumentException - If the property name is not one of the constants in this class.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()