Package com.levigo.jadice.document.outline

Class Outlines

java.lang.Object

com.levigo.jadice.document.outline.Outlines

public final class Outlines
extends Object

A collection of static utility methods to be used in conjunction with Outlines.

Field Summary

Fields

Modifier and Type	Field	Description
static String	TYPE_CUSTOM_OUTLINE	This outline type is used for custom, application-specific outlines.
static String	TYPE_EMBEDDED_OUTLINE	This outline type is used for outlines embedded with the document.
static String	TYPE_INDEX_OUTLINE	This outline type is used for outlines dynamically generated from a tag index.

Method Summary

Modifier and Type	Method	Description
static void	attach(Outline<?> outline, PropertiesProvider propertiesProvider)	Set or replace the Outline of the given type for the given PropertiesProvider with this outline.
static Outline<?>	get(PropertiesProvider propertiesProvider, String type)	Get the Outline of the given type for the given PropertiesProvider.
static String	getPropertyKey(Outline<?> outline)	Return the property key used to attach the given outline to a PropertiesProvider.
static String	getPropertyKey(String type)	Return the property key used to attach outlines of the given type to a PropertiesProvider.

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_EMBEDDED_OUTLINE

public static final String TYPE_EMBEDDED_OUTLINE

This outline type is used for outlines embedded with the document. Typical examples are a PDF Outline or a MO:DCA document index.

See Also:

Constant Field Values

TYPE_INDEX_OUTLINE

public static final String TYPE_INDEX_OUTLINE

This outline type is used for outlines dynamically generated from a tag index. Thy could, for example, be created from the logical structure found in a PDF document.

See Also:

Constant Field Values

TYPE_CUSTOM_OUTLINE

public static final String TYPE_CUSTOM_OUTLINE

This outline type is used for custom, application-specific outlines. Outlines may be registered under arbitrary type identifiers. However, some components may also rely on well-known type identifiers. Use of this identifier signals a generic custom outline.

See Also:

Constant Field Values

Method Detail

getPropertyKey

public static String getPropertyKey(String type)

Return the property key used to attach outlines of the given type to a PropertiesProvider. This is the key that will be used by attach(Outline,PropertiesProvider).

Returns:

the property key

getPropertyKey

public static String getPropertyKey(Outline<?> outline)

Return the property key used to attach the given outline to a PropertiesProvider. This is the key that will be used by attach(Outline,PropertiesProvider).

Returns:

the property key

get

public static Outline<?> get(PropertiesProvider propertiesProvider,
                             String type)

Get the Outline of the given type for the given PropertiesProvider. Return null if the requested Outline does not exist. The type of outline may be any custom type identifier or one of the predefined ones.

Parameters:

propertiesProvider - the context PropertiesProvider for which to retrieve the Outline

type - the type of outline to retrieve

Returns:

the Outline or null

attach

public static void attach(Outline<?> outline,
                          PropertiesProvider propertiesProvider)

Set or replace the Outline of the given type for the given PropertiesProvider with this outline. The type of outline may be any custom type identifier or one of the predefined ones.

Parameters:

propertiesProvider - the properties provider into which to put the Outline