org.fife.rtext.plugins.tidy
Class XmlOptions

java.lang.Object
  extended byorg.fife.ui.app.Prefs
      extended byorg.fife.rtext.plugins.tidy.XmlOptions

public class XmlOptions
extends Prefs

Options for tidying XML.

While all fields in this class are public, please use the getters and setters for accessing them for bounds checking, etc.

Version:
1.0
Author:
Robert Futrell

Field Summary
 boolean addXmlDeclaration
           
 int xmlSpaceCount
           
 int xmlWrapLength
           
 
Constructor Summary
XmlOptions()
           
 
Method Summary
 boolean getAddXmlDeclaration()
          Returns whether the XML declaration should be added.
 int getSpaceCount()
          Returns the number of spaces to use for indentation when formatting XML.
 int getWrapLength()
          Returns how long formatted lines can be before they are wrapped.
 void setAddXmlDeclaration(boolean add)
          Sets whether the XML declaration should be added.
 void setDefaults()
          Sets all fields in this class to their default values.
 void setSpaceCount(int count)
          Sets the number of spaces to use for indentation when formatting XML.
 void setWrapLength(int length)
          Sets how long formatted lines can be before they are wrapped.
 
Methods inherited from class org.fife.ui.app.Prefs
load, load, save, save
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

addXmlDeclaration

public boolean addXmlDeclaration

xmlSpaceCount

public int xmlSpaceCount

xmlWrapLength

public int xmlWrapLength
Constructor Detail

XmlOptions

public XmlOptions()
Method Detail

getAddXmlDeclaration

public boolean getAddXmlDeclaration()
Returns whether the XML declaration should be added.

Returns:
Whether the XML declaration should be added.
See Also:
setAddXmlDeclaration(boolean)

getSpaceCount

public int getSpaceCount()
Returns the number of spaces to use for indentation when formatting XML.

Returns:
The number of spaces to use.
See Also:
setSpaceCount(int)

getWrapLength

public int getWrapLength()
Returns how long formatted lines can be before they are wrapped.

Returns:
The maximum length of a formatted line, or "0" for no limit.
See Also:
setWrapLength(int)

setAddXmlDeclaration

public void setAddXmlDeclaration(boolean add)
Sets whether the XML declaration should be added.

Parameters:
add - Whether the XML declaration should be added.
See Also:
getAddXmlDeclaration()

setDefaults

public void setDefaults()
Sets all fields in this class to their default values.

Specified by:
setDefaults in class Prefs

setSpaceCount

public void setSpaceCount(int count)
Sets the number of spaces to use for indentation when formatting XML.

Parameters:
count - The number of spaces.
See Also:
getSpaceCount()

setWrapLength

public void setWrapLength(int length)
Sets how long formatted lines can be before they are wrapped.

Parameters:
length - The maximum length of a formatted line, or "0" for no limit.
See Also:
getWrapLength()