ilog.views.symbology.palettes

Class IlvPaletteDocumentation

java.lang.Object

ilog.views.symbology.palettes.IlvPaletteDocumentation

public class IlvPaletteDocumentation
extends Object

Creates the documentation for a palette or for a set of symbols.

The documentation is written to an HTML file. The file and its associated images are written to a temporary directory. However, it can be saved in a user defined directory.

To create the documentation, we create a DOM representing the palette, or the symbols. This DOM is then transformed with an XSLT file used to produce HTML content.

Since:

JViews 8.1

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY_ELEMENT
static String	CLASSNAME_ATTRIBUTE
static String	CSS_ATTRIBUTE
static String	EDITOR_ATTRIBUTE
static String	ICON_ATTRIBUTE
static String	ID_ATTRIBUTE
static String	NAME_ATTRIBUTE
static String	PALETTE_ELEMENT
static String	PARAM_ELEMENT
static String	READONLY_ATTRIBUTE
static String	RESOURCE_ELEMENT
static String	SYMBOL_ELEMENT
static String	TYPE_ATTRIBUTE
static String	VALUE_ATTRIBUTE
static String	VALUE_ELEMENT
static String	VALUESET_ATTRIBUTE
static String	VALUESET_ELEMENT
static String	VERSION_ATTRIBUTE
static String	VISIBLE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
IlvPaletteDocumentation(File workingDirectory) Creates this documentation generator.

Method Summary

Modifier and Type	Method and Description
URL	createPaletteDocumentation(IlvPalette palette) Creates documentation for a whole palette.
URL	createPaletteObjectsDocumentation(IlvPaletteObject[] objects) Creates documentation for the given symbols or categories.
void	saveTo(File dest) Copies the documentation that has been created in the working directory into the destination directory specified by the user.

Methods inherited from class java.lang.Object

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

Field Detail

PALETTE_ELEMENT

public static final String PALETTE_ELEMENT

SYMBOL_ELEMENT

public static final String SYMBOL_ELEMENT

CATEGORY_ELEMENT

public static final String CATEGORY_ELEMENT

PARAM_ELEMENT

public static final String PARAM_ELEMENT

RESOURCE_ELEMENT

public static final String RESOURCE_ELEMENT

VALUESET_ELEMENT

public static final String VALUESET_ELEMENT

VALUE_ELEMENT

public static final String VALUE_ELEMENT

ID_ATTRIBUTE

public static final String ID_ATTRIBUTE

ICON_ATTRIBUTE

public static final String ICON_ATTRIBUTE

CLASSNAME_ATTRIBUTE

public static final String CLASSNAME_ATTRIBUTE

CSS_ATTRIBUTE

public static final String CSS_ATTRIBUTE

VALUE_ATTRIBUTE

public static final String VALUE_ATTRIBUTE

TYPE_ATTRIBUTE

public static final String TYPE_ATTRIBUTE

EDITOR_ATTRIBUTE

public static final String EDITOR_ATTRIBUTE

VALUESET_ATTRIBUTE

public static final String VALUESET_ATTRIBUTE

VERSION_ATTRIBUTE

public static final String VERSION_ATTRIBUTE

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

READONLY_ATTRIBUTE

public static final String READONLY_ATTRIBUTE

VISIBLE_ATTRIBUTE

public static final String VISIBLE_ATTRIBUTE

Constructor Detail

IlvPaletteDocumentation

public IlvPaletteDocumentation(File workingDirectory)

Creates this documentation generator.

Parameters:

workingDirectory - The working directory where the files will be saved.

Method Detail

createPaletteDocumentation

public URL createPaletteDocumentation(IlvPalette palette)

Creates documentation for a whole palette.

Parameters:

palette - The palette to document.

Returns:

URL The URL of the HTML file that has been created.

createPaletteObjectsDocumentation

public URL createPaletteObjectsDocumentation(IlvPaletteObject[] objects)

Creates documentation for the given symbols or categories.

Parameters:

objects - The palette objects.

Returns:

URL The URL of the HTML file that has been created.

saveTo

public void saveTo(File dest)

Copies the documentation that has been created in the working directory into the destination directory specified by the user.

Parameters:

dest - The destination directory.