public class IlvPaletteDocumentation extends Object
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.
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 and Description |
---|
IlvPaletteDocumentation(File workingDirectory)
Creates this documentation generator.
|
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.
|
public static final String PALETTE_ELEMENT
public static final String SYMBOL_ELEMENT
public static final String CATEGORY_ELEMENT
public static final String PARAM_ELEMENT
public static final String RESOURCE_ELEMENT
public static final String VALUESET_ELEMENT
public static final String VALUE_ELEMENT
public static final String ID_ATTRIBUTE
public static final String ICON_ATTRIBUTE
public static final String CLASSNAME_ATTRIBUTE
public static final String CSS_ATTRIBUTE
public static final String VALUE_ATTRIBUTE
public static final String TYPE_ATTRIBUTE
public static final String EDITOR_ATTRIBUTE
public static final String VALUESET_ATTRIBUTE
public static final String VERSION_ATTRIBUTE
public static final String NAME_ATTRIBUTE
public static final String READONLY_ATTRIBUTE
public static final String VISIBLE_ATTRIBUTE
public IlvPaletteDocumentation(File workingDirectory)
workingDirectory
- The working directory where the files will be saved.public URL createPaletteDocumentation(IlvPalette palette)
palette
- The palette to document.public URL createPaletteObjectsDocumentation(IlvPaletteObject[] objects)
objects
- The palette objects.public void saveTo(File dest)
dest
- The destination directory.© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.