|
||||||||||
PREV NEXT | FRAMES NO FRAMES |
Document
builders that add element location information into the generated element nodes.AbstractJavaEntity
)
using an AOP-like expressions syntax to select classes, methods and fields.NodeList
to a java list of Node
instances.
Globals.attachBinaryContent(URL)
.
Globals.attachBinaryContent(String, URL)
.
Globals.attachBinaryContent(String, URL)
.
Globals.attachBinaryContent(String, java.io.InputStream)
.
Globals.attachBinaryContent(String, java.io.InputStream)
.
BrushResolver
defines an interface that may be implemented and registered via service loading to register additional
javascript brushes (= language support) for the syntax highlighting library.EasyFactoryConfiguration
.
highlight("css", code)
.
VelocityConfigurator
which sets various defaults.DirectoryLoader.PARAM_ALIAS
" alias functionality.RequestParameterTransformer.TRANSFORMERS
).
InterfaceScanner.LEGACY_PARAM_ALIAS
" alias functionality.RequestParameterTransformer.TRANSFORMERS
).
highlight("java", code)
.
JavaSourceLoader.PARAM_ALIAS
" alias functionality.RequestParameterTransformer.TRANSFORMERS
).
highlight("js", code)
.
highlight("html/jsp", code)
.
Node.getUserData(String)
) that may be used to return the column number of an element node.
Node.getUserData(String)
) that may be used to return the line number of an element node.
InitializeMacroMojo
.InitializeMacroMojo
.RequestParameterTransformer
that is triggered when the parameter
"message-box
" is set with the macro call."constants"
presented as Map<String,Map<?
"declaredConstants"
presented as Map<String,Map<?
"declaredFields"
presented as Map<String,Map<?
Document
) and can be accessed from velocity templates.
Document
) and can be accessed from velocity templates.
"fields"
presented as Map<String,Map<?
"interfaceMethods"
presented as Map<String,Map<?
JavaClass
instance of the specified class and allows
accessing the QDox reflection model directly.
Properties
instance.
new SelectableArrayList
<String>(new TreeSet<String>(properties.keySet()));
).
"methods"
presented as Map<String,Map<?
xpath
" but configured to match on the original document.
"properties"
presented as Map<String,Map<?
JavaSourceLoader.Selector
that may be used to access nested, super, implemented and derived classes.
XmlLoader
for details.
XPathEvaluator
" that is configured to match xpath expressions
against DOM tree of document
.
<?
- PARAM_ADD_XSL -
Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
- Optional parameter, sets a relative or absolute URL to an XSL file that is added as standard template
to the document being included but it is not executed.
- PARAM_ALIAS -
Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
- Defines a shortcut for the request properties 'source-class' and 'directories'.
- PARAM_ALIAS -
Static variable in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
- Defines a shortcut for the request properties 'source-class' and 'java-source'.
- PARAM_ALIAS -
Static variable in class org.tinyjee.maven.dim.extensions.PropertiesLoader
- Defines a shortcut for the request properties '
source-class
' and 'properties
'.
- PARAM_ALIAS -
Static variable in class org.tinyjee.maven.dim.extensions.ScriptInvoker
- Defines a shortcut for the request properties 'source-class' and 'script'.
- PARAM_ALIAS -
Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
- Defines a shortcut for the request properties 'source-class' and 'svg'.
- PARAM_ALIAS -
Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
- Defines a shortcut for the request properties 'source-class' and 'xml'.
- PARAM_API_DOCS -
Static variable in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
- Optional input parameter specifying the standard path to the apidocs to use when linking via
{@link} or {@linkplain}.
- PARAM_ATTACH -
Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
- Specifies whether the SVG is attached to the page (instead of copied straight to the document).
- PARAM_BACKGROUND_COLOR -
Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
- Optional parameter overriding the color of the message box background.
- PARAM_CELL_STYLE -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Optional Parameter: Defines the CSS style of the TD elements.
- PARAM_CHARSET -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Defines the charset to use when loading the source content.
- PARAM_CHARSET_AUTODETECT -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Toggles whether charset detection is used when loading source content.
- PARAM_COLOR -
Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
- Optional parameter overriding the border color of the message box.
- PARAM_COLUMN_CLASSES -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Optional Parameter: Specifies a comma separates list of classes to apply with the columns.
- PARAM_COLUMN_WIDTHS -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Optional Parameter: Specifies a comma separates list of width values (CSS format) to apply with the columns.
- PARAM_COLUMNS -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Specifies the number of columns to render (defaults to '
*
').
- PARAM_DIRECTION -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Defines the direction for placing the sections in the table layout (defaults to '
top-down
').
- PARAM_DIRECTORIES -
Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
- Sets a comma separated list of URL or local path pointing to directories to load recursively.
- PARAM_FILE -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Sets the source path using
java.io.File
instead of evaluating it against URL
or File paths.
- PARAM_GAP -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Defines the gab (margin) between the table cells (defaults to '
10pt
').
- PARAM_HEIGHT -
Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
- Optional Parameter, sets the height in pixel.
- PARAM_HIDE_TITLES -
Static variable in class org.tinyjee.maven.dim.extensions.TabbedPanelParameterTransformer
- Toggles whether section titles are hidden once they were transformed into a tab (defaults to 'true').
- PARAM_HIGHLIGHT -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Deprecated.
- PARAM_HIGHLIGHT_LINES -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Defines lines to highlight inside verbatim content using the same selection logic as used within the "
snippet
" parameter.
- PARAM_HIGHLIGHT_THEME -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Sets the highlighting color theme to use.
- PARAM_HIGHLIGHT_TYPE -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Sets the highlighter (brush) to use when highlighting verbatim content.
- PARAM_ICON -
Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
- Optional parameter setting a site resource path to the image that is used with the message box instead of
the built-in SVG graphics.
- PARAM_INDENT -
Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
- Optional parameter, toggles whether the XML is indented before inclusion.
- PARAM_INLINE_CSS -
Static variable in class org.tinyjee.maven.dim.extensions.InlineCssParameterTransformer
- Enables this extension and sets the content to place inside the inlined "<style>" element.
- PARAM_INLINE_SCRIPT -
Static variable in class org.tinyjee.maven.dim.extensions.InlineScriptParameterTransformer
- Enables this extension and sets the content to place inside the inlined "<script>" element.
- PARAM_JAVA_SOURCE -
Static variable in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
- Is the expected input parameter that points to the class or interface to scan.
- PARAM_JSON -
Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
- Experimental: Sets the URL or local path to JSON encoded content that is translated to XML and included.
- PARAM_LOAD_SCHEMA -
Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
- Enum parameter that specifies whether XML schemata are loaded in order to include them with the XML content.
- PARAM_MESSAGE_BOX -
Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
- Enables this extension and sets the text to display inside the message box.
- PARAM_MIN_HEIGHT -
Static variable in class org.tinyjee.maven.dim.extensions.TabbedPanelParameterTransformer
- Optional Parameter: Specifies a minimum tab height to improve scrolling behaviour when switching tabs.
- PARAM_NAMESPACE_AWARE -
Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
- Optional parameter, toggles whether the XML parser handles namespaces.
- PARAM_NO_CACHE -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Forces the re-loading of source content when set to
true
.
- PARAM_OUT_FILES -
Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
- Is set with a selectable list of
FileReference
instances of all files that were found in the given directories.
- PARAM_OUT_JAVA_CLASSES -
Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
- Is set with a selectable list of all java classes found in the given directories.
- PARAM_OUT_PROPERTY_FILES -
Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
- Is set with a selectable list of
FileReference
instances of all XML files that were found in the given
directories.
- PARAM_OUT_XML_FILES -
Static variable in class org.tinyjee.maven.dim.extensions.DirectoryLoader
- Is set with a selectable list of
FileReference
instances of all XML files that were found in the given
directories.
- PARAM_OVERWRITE -
Static variable in class org.tinyjee.maven.dim.extensions.JavaSourceLoader
- Optional boolean input parameter specifying whether the extension overwrites other input parameters.
- PARAM_PAD_LINE_NUMBERS -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Pads all line numbers by the specified amount of zeros (if gutter is shown).
- PARAM_PROPERTIES -
Static variable in class org.tinyjee.maven.dim.extensions.PropertiesLoader
- Sets the path to the properties file to load inside the request parameters.
- PARAM_RENDER -
Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
- Specifies whether the SVG is rendered to an image and included.
- PARAM_RENDER_BACKGROUND -
Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
- Specifies a background color to use when rendering an SVG to an image.
- PARAM_RENDER_MEDIA -
Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
- Specifies the CSS media when rendering an SVG containing CSS stylesheets with alternating media styles.
- PARAM_ROW_CLASSES -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Optional Parameter: Specifies a comma separates list of classes to apply with the rows.
- PARAM_ROW_HEIGHTS -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Optional Parameter: Specifies a comma separates list of height values (CSS format) to apply with the rows.
- PARAM_ROWS -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Specifies the number of rows to render (defaults to '
*
').
- PARAM_SCRIPT -
Static variable in class org.tinyjee.maven.dim.extensions.ScriptInvoker
- Sets the URL or local path to the script file to load and evaluate.
- PARAM_SCRIPT_TYPE -
Static variable in class org.tinyjee.maven.dim.extensions.InlineScriptParameterTransformer
- Defines the language of the script to include, defaults to "javascript".
- PARAM_SET_FIRST_LINE -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Sets the line number to use for the first line (if gutter is shown).
- PARAM_SHOW_GUTTER -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Toggles whether the gutter including line numbers is shown for verbatim content.
- PARAM_SITE_DIRECTORY -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Deprecated.
- PARAM_SNIPPET -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Sets one or more comma separated expression to select the content snippets to include.
- PARAM_SNIPPET_END_OFFSET -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Optional parameter that can be used to grow the end of snippet selections by the given amount of lines.
- PARAM_SNIPPET_GROW_EXCLUDES -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Optional boolean parameter that toggles whether growing is applied to exclusions as well.
- PARAM_SNIPPET_GROW_OFFSET -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Optional parameter that can be used to grow snippet selections by the given amount of lines.
- PARAM_SNIPPET_ID -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Deprecated.
- PARAM_SNIPPET_START_OFFSET -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Optional parameter that can be used to grow the start of snippet selections by the given amount of lines.
- PARAM_SOURCE -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Sets the content to include using a source path, source URL or the fully qualified java class name.
- PARAM_SOURCE_CLASS -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Sets a class to use as dynamic source for content, request parameters or both.
- PARAM_SOURCE_CONTENT -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Sets the source content inline with the macro call.
- PARAM_SOURCE_CONTENT_TYPE -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Sets the content type of the source.
- PARAM_SOURCE_IS_TEMPLATE -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Toggles whether the source content is treated as a Velocity template.
- PARAM_STYLE -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Optional Parameter: Defines the CSS style of the container hosting the elements.
- PARAM_STYLE_CLASS -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Optional Parameter: Defines the CSS style class of the container hosting the elements.
- PARAM_SVG -
Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
- Sets the URL or local path to the SVG file to load inside the request parameters.
- PARAM_TABBED_PANEL -
Static variable in class org.tinyjee.maven.dim.extensions.TabbedPanelParameterTransformer
- Enables this extension and sets a regular expression matching the section titles that should be transformed into a tabs.
- PARAM_TABLE_LAYOUT -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Enables this extension and sets a regular expression matching the section titles that should be transformed into a tabs.
- PARAM_TEXT_COLOR -
Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
- Optional parameter overriding the text color of the message box.
- PARAM_TYPE -
Static variable in class org.tinyjee.maven.dim.extensions.MessageBoxParameterTransformer
- Optional parameter specifying the type of message box to display.
- PARAM_VERBATIM -
Static variable in interface org.tinyjee.maven.dim.IncludeMacroSignature
- Toggles whether the content is verbatim (included as source) or non-verbatim (included
as markup and interpreted).
- PARAM_WIDTH -
Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
- Optional Parameter, sets the width in pixel.
- PARAM_WIDTH -
Static variable in class org.tinyjee.maven.dim.extensions.TableLayoutParameterTransformer
- Defines the width of the layout (defaults to '
100%
').
- PARAM_XML -
Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
- Sets the URL or local path to the XML file to load inside the request parameters.
- PARAM_XML_CLASS -
Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
- Sets a fully qualified class name to a class that either provides a
Document
instance, a Source
or is annotated with XmlRootElement
.
- PARAM_XSL -
Static variable in class org.tinyjee.maven.dim.extensions.SvgLoader
- Optional Parameter, transform the given input (e.g.
- PARAM_XSL -
Static variable in class org.tinyjee.maven.dim.extensions.XmlLoader
- Optional parameter, sets the path to an XSL file that is used to transform the given input.
- parameters -
Variable in class org.tinyjee.maven.dim.spi.AbstractSource
-
- parse(URL) -
Method in class org.tinyjee.maven.dim.utils.AbstractPositioningDocumentBuilder
- Parses the given URL to a
Document
.
- parse(URL, Reader) -
Method in class org.tinyjee.maven.dim.utils.AbstractPositioningDocumentBuilder
- Parses the given URL to a
Document
.
- parse(URL) -
Method in class org.tinyjee.maven.dim.utils.PositioningDocumentBuilder
- Parses the given XML document.
- parse(URL, Reader) -
Method in class org.tinyjee.maven.dim.utils.PositioningDocumentBuilder
-
- parse(URL) -
Method in class org.tinyjee.maven.dim.utils.PositioningJsonDocumentBuilder
-
- parse(URL, Reader) -
Method in class org.tinyjee.maven.dim.utils.PositioningJsonDocumentBuilder
-
- parseCallStack(String) -
Static method in class org.tinyjee.maven.dim.utils.ClassUtils
-
- PositioningDocumentBuilder - Class in org.tinyjee.maven.dim.utils
- Creates a
Document
builder that adds user-data into the parsed DOM nodes that covers line number and column information. - PositioningDocumentBuilder(boolean) -
Constructor for class org.tinyjee.maven.dim.utils.PositioningDocumentBuilder
- Creates a new document builder that adds line and column number to the user data sections of resulting element nodes.
- PositioningJsonDocumentBuilder - Class in org.tinyjee.maven.dim.utils
- Creates a
Document
builder that parses JSON instead of XML and adds user-data into the parsed DOM nodes that covers
line number and column information. - PositioningJsonDocumentBuilder() -
Constructor for class org.tinyjee.maven.dim.utils.PositioningJsonDocumentBuilder
-
- PrintableMap<K,V> - Class in org.tinyjee.maven.dim.utils
- Extends LinkedHashMap with the ability to print the map's contents as formatted string.
- PrintableMap(String) -
Constructor for class org.tinyjee.maven.dim.utils.PrintableMap
-
- PrintableMap(Map<? extends K, ? extends V>, String) -
Constructor for class org.tinyjee.maven.dim.utils.PrintableMap
-
- printContent() -
Method in class org.tinyjee.maven.dim.utils.PrintableMap
-
- processJavaDocComment(String) -
Method in class org.tinyjee.maven.dim.extensions.JavaDocTagsHandler
- Processes all inline tags inside the javadoc comment.
- processRawContent(Source, SortedMap<Integer, List<String>>, Sink) -
Method in class org.tinyjee.maven.dim.IncludeMacro
- Sends raw text to the sink.
- processSource(Map<String, String>, File, Source, Sink) -
Method in class org.tinyjee.maven.dim.IncludeMacro
- Processes the given source to the Sink.
- PropertiesLoader - Class in org.tinyjee.maven.dim.extensions
- PropertiesLoader is a 'source-class' compatible helper class that can load a properties file
and add or overwrite the request properties by the properties contained in the file.
- PropertiesLoader(File, Map<String, Object>) -
Constructor for class org.tinyjee.maven.dim.extensions.PropertiesLoader
- Constructs a new properties loader searching for properties using the given base path.
- PropertiesLoader - Class in org.tinyjee.maven.dim.utils
- Deprecated.
- PropertiesLoader(File, Map<String, Object>) -
Constructor for class org.tinyjee.maven.dim.utils.PropertiesLoader
- Deprecated.
- PropertiesLoader.AliasHandler - Class in org.tinyjee.maven.dim.extensions
- Implements the "
PropertiesLoader.PARAM_ALIAS
" alias functionality. - PropertiesLoader.AliasHandler() -
Constructor for class org.tinyjee.maven.dim.extensions.PropertiesLoader.AliasHandler
- Constructs the handler (Note: Is called by
RequestParameterTransformer.TRANSFORMERS
).
- put(String, String) -
Method in class org.tinyjee.maven.dim.sources.AbstractParametricVelocityTool
- Sets a parameter that will be used with the next invocation.
regular expression
based snippet selector using the expression prefix "RE:".RequestParameterTransformer
defines an interface that may be implemented and registered via service loading
to plug parameter transformers that adjust macro parameters on the fly before any other operation is triggered.UrlFetcher
.
ScriptInvoker.PARAM_ALIAS
" alias functionality.RequestParameterTransformer.TRANSFORMERS
).
AbstractJavaEntity
.AbstractSelectableJavaEntitiesList
to let it host output from JavaSourceLoader
.SnippetSelector
defines an interface that may be implemented and registered via service loading
to add new snippet selection mechanisms.SvgLoader.PARAM_ALIAS
" alias functionality.RequestParameterTransformer.TRANSFORMERS
).
AbstractJavaEntity
inside AbstractSelectableJavaEntitiesList.unwrapToEntity(Object)
.
AbstractJavaEntity
.
VelocityConfigurator
defines an interface that may be implemented and registered via service loading
to customize the configuration of the velocity template engine and context before the templates are rendered.highlight("xml", code)
.
XmlLoader.PARAM_ALIAS
" alias functionality.RequestParameterTransformer.TRANSFORMERS
).
XPathEvaluator
.
|
||||||||||
PREV NEXT | FRAMES NO FRAMES |