com.tngtech.freemind2wiki
Class FM2ConfluenceConverter

java.lang.Object
  com.tngtech.freemind2wiki.FM2ConfluenceConverter

All Implemented Interfaces:

Converter

public class FM2ConfluenceConverter
extends java.lang.Object
implements Converter

Converts a FreeMind mind-map (*.mm) to Confluence markup.

See http://confluence.atlassian.com/renderer/notationhelp.action?section=all for a description of the Confluence markup.

The converter supports the following features of a FreeMind mind-map:

• Links
• Colors
• Icons
• Bold
• Italic

Constructor Summary

FM2ConfluenceConverter()

Method Summary

void	convert(java.io.Reader source, java.io.Writer target) Starts the conversion process.
int	getHeaderNestingDepth() Number of headers to use for nesting.
boolean	isCreateOrderedLists() If true, this converter creates Confluence nestings using ordered, enumerated lists.
boolean	isIgnoreColors() If true, node colors will not be converted.
boolean	isIgnoreFontStyle() If true, this converter will ignore node formatting settings (bold and italic).
boolean	isIgnoreIcons() If true icons will not be converted
boolean	isIgnoreLinks() If true links will not be converted.
void	setCreateOrderedLists(boolean createOrderedLists) If true, this converter creates nestings using ordered, enumerated lists.
void	setHeaderNestingDepth(int headerNestingDepth) Set the header nesting depth
void	setIgnoreColors(boolean ignoreColors) If true, node colors will not be converted.
void	setIgnoreFontStyle(boolean ignoreFontStyle) If true, this converter will ignore node formatting settings (bold and italic).
void	setIgnoreIcons(boolean ignoreIcons) If true icons will not be converted
void	setIgnoreLinks(boolean ignoreLinks) If true links will not be converted

Methods inherited from class java.lang.Object

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

Constructor Detail

FM2ConfluenceConverter

public FM2ConfluenceConverter()

Method Detail

convert

public void convert(java.io.Reader source,
                    java.io.Writer target)
             throws java.io.IOException

Description copied from interface: Converter

Starts the conversion process.

Specified by:

convert in interface Converter

Parameters:

source - stream will be closed after reading.

target - stream will be closed after writing.

Throws:

java.io.IOException - an exception if there is an IO problem

isCreateOrderedLists

public boolean isCreateOrderedLists()

If true, this converter creates Confluence nestings using ordered, enumerated lists.

Returns:

true if this converter creates Confluence nestings using ordered, enumerated lists, false otherwise

setCreateOrderedLists

public void setCreateOrderedLists(boolean createOrderedLists)

If true, this converter creates nestings using ordered, enumerated lists.

Parameters:

createOrderedLists - true if this converter creates nestings using ordered, enumerated lists, false otherwise

isIgnoreFontStyle

public boolean isIgnoreFontStyle()

If true, this converter will ignore node formatting settings (bold and italic).

Returns:

true if this converter will ignore node formatting settings (bold and italic), false otherwise

setIgnoreFontStyle

public void setIgnoreFontStyle(boolean ignoreFontStyle)

If true, this converter will ignore node formatting settings (bold and italic).

Parameters:

ignoreFontStyle - true if this converter will ignore node formatting settings (bold and italic), false otherwise

isIgnoreIcons

public boolean isIgnoreIcons()

If true icons will not be converted

Returns:

true if the icons will not be converted, false otherwise

setIgnoreIcons

public void setIgnoreIcons(boolean ignoreIcons)

If true icons will not be converted

Parameters:

ignoreIcons - true if icons will not be converted, false otherwise

isIgnoreColors

public boolean isIgnoreColors()

If true, node colors will not be converted.

Returns:

true if node colors will not be converted, false otherwise

setIgnoreColors

public void setIgnoreColors(boolean ignoreColors)

If true, node colors will not be converted.

Parameters:

ignoreColors - true if node colors will not be converted, false otherwise

isIgnoreLinks

public boolean isIgnoreLinks()

If true links will not be converted.

Returns:

true if links will not be converted, false otherwise

setIgnoreLinks

public void setIgnoreLinks(boolean ignoreLinks)

If true links will not be converted

Parameters:

ignoreLinks - true if links will not be converted, false otherwise

getHeaderNestingDepth

public int getHeaderNestingDepth()

Number of headers to use for nesting. A value headerNestingDepth = 3 denotes that headers h1, h2, h3 should be used for nesting and nodes with greater depths will be nested using ordered or unordered lists in confluence markup.

Returns:

numbers of headers to use for nesting.

setHeaderNestingDepth

public void setHeaderNestingDepth(int headerNestingDepth)

Set the header nesting depth

Parameters:

headerNestingDepth - the maximum header nesting depth

See Also:

getHeaderNestingDepth()