|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sourceforge.jsxe.jsXe
The main class of the java simple XML editor (jsXe)
Field Summary | |
static String |
MIN_JAVA_VERSION
The minimum version of the Java Runtime Environment needed to run and compile jsXe |
static String |
MIN_XERCES_VERSION
The minimum version of Xerces that is needed to run jsXe |
Method Summary | |
static boolean |
closeAllDocumentBuffers(TabbedView view)
Closes all open DocumentBuffers. |
static boolean |
closeDocumentBuffer(TabbedView view,
DocumentBuffer buffer)
Closes an open DocumentBuffer. |
static boolean |
closeDocumentBuffer(TabbedView view,
DocumentBuffer buffer,
boolean confirmClose)
Overloaded version of closeDocumentBuffer() method. |
static void |
exit(TabbedView view)
Called when exiting jsXe. |
static void |
exiterror(Object source,
Object error,
int errorcode)
Called when crashing jsXe. |
static TabbedView |
getActiveView()
Gets the currently active view. |
static String |
getAppTitle()
Gets the title of the jsXe application. |
static boolean |
getBooleanProperty(String name,
boolean defaultValue)
Gets the value of an boolean property. |
static BufferHistory |
getBufferHistory()
Gets jsXe's buffer history. |
static String |
getBuild()
Gets the internal build version for jsXe. |
static Date |
getBuildDate()
Gets the date that jsXe was built as a string. |
static InputStream |
getDefaultDocument()
Gets the default XML document in jsXe. |
static String |
getDefaultProperty(String key)
Gets a default global property. |
static DocumentBuffer[] |
getDocumentBuffers()
Gets an array of the open Buffers. |
static Font |
getFontProperty(String name)
Returns the value of a font property. |
static Font |
getFontProperty(String name,
Font def)
Returns the value of a font property. |
static String |
getHomeDirectory()
Returns the path to the user's home directory. |
static ImageIcon |
getIcon()
Gets jsXe's icon that is displayed in the about menu, taskbar and upper left hand corner (where appropriate) |
static String |
getInstallDirectory()
Returns the path to where jsXe is installed |
static int |
getIntegerProperty(String key,
int defaultValue)
Returns the value of an integer property. |
static DocumentBuffer |
getOpenBuffer(File file)
Gets the DocumentBuffer for this file if the file is open already. |
static JARClassLoader |
getPluginLoader()
Gets the plugin loader that is used to load plugins into jsXe |
static String |
getProperty(String key)
Gets a jsXe global property. |
static String |
getProperty(String key,
String defaultValue)
Gets a jsXe global property. |
static String |
getSettingsDirectory()
Returns the path of the directory where user-specific settings are stored. |
static String |
getVersion()
Gets the formatted, human readable version of jsXe. |
static boolean |
isExiting()
Indicates whether jsXe is exiting i.e. |
static void |
main(String[] args)
The main method of jsXe |
static boolean |
openXMLDocument(TabbedView view,
File file)
Attempts to open an XML document in jsXe from a file on disk. |
static boolean |
openXMLDocument(TabbedView view,
File file,
Properties properties,
String viewName)
Attempts to open an XML document in jsXe from a file on disk. |
static boolean |
openXMLDocument(TabbedView view,
InputStream stream)
Attempts to open an XML document in the form of a Reader object as an untitled document. |
static boolean |
openXMLDocument(TabbedView view,
String doc)
Attempts to open an XML document in the form of a String object as an untitled document. |
static void |
setBooleanProperty(String name,
boolean value)
Sets the value of an boolean property. |
static void |
setFontProperty(String name,
Font value)
Sets the value of a font property. |
static void |
setIntegerProperty(String name,
int value)
Sets the value of an integer property. |
static Object |
setProperty(String key,
String value)
Sets a global property to jsXe. |
static boolean |
showOpenFileDialog(TabbedView view)
Shows an open file dialog for jsXe. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String MIN_JAVA_VERSION
public static final String MIN_XERCES_VERSION
Method Detail |
public static void main(String[] args)
args
- The command line argumentspublic static String getBuild()
public static Date getBuildDate()
public static String getVersion()
public static ImageIcon getIcon()
public static String getInstallDirectory()
public static String getHomeDirectory()
public static String getSettingsDirectory()
public static String getAppTitle()
public static TabbedView getActiveView()
public static boolean showOpenFileDialog(TabbedView view) throws IOException
view
- The view that is to be the parent of the file dialog
IOException
- if the document does not validate or cannot be opened for some reason.public static boolean openXMLDocument(TabbedView view, File file) throws IOException
view
- The view to open the document in.file
- The file to open.
IOException
- if the document does not validate or cannot be opened for some reason.public static boolean openXMLDocument(TabbedView view, File file, Properties properties, String viewName) throws IOException
view
- The view to open the document in.file
- The file to open.properties
- the properties to set to the new documentviewName
- the name of the view to open this document in
IOException
- if the document does not validate or cannot be opened for some reason.public static boolean openXMLDocument(TabbedView view, String doc) throws IOException
view
- The view to open the document in.doc
- The String document to open.
IOException
- if the document does not validate or cannot be opened for some reason.public static boolean openXMLDocument(TabbedView view, InputStream stream) throws IOException
view
- The view to open the document in.stream
- The stream to the document.
IOException
- if the document does not validate or cannot be opened for some reason.public static DocumentBuffer getOpenBuffer(File file)
file
- The file that is open in jsXe
public static boolean closeDocumentBuffer(TabbedView view, DocumentBuffer buffer) throws IOException
view
- The view that contains the buffer.buffer
- The buffer to close.
IOException
- if the user chooses to save and the file cannot be saved
because of an I/O error.public static boolean closeDocumentBuffer(TabbedView view, DocumentBuffer buffer, boolean confirmClose) throws IOException
view
- The view that contains the buffer.buffer
- The buffer to close.confirmClose
- Whether or not user should be asked to confirm that they want to save file,
before being sent to JFileChooser.
IOException
- if the user chooses to save and the file cannot be saved
because of an I/O error.public static boolean closeAllDocumentBuffers(TabbedView view) throws IOException
view
- the view that initiated the close
IOException
- if the user chooses to save and the file cannot
be saved because of an I/O errorpublic static BufferHistory getBufferHistory()
public static InputStream getDefaultDocument()
public static DocumentBuffer[] getDocumentBuffers()
public static void exit(TabbedView view)
view
- The view from which the exit was called.public static void exiterror(Object source, Object error, int errorcode)
error
- The error. Either a string or Exception.errorcode
- The errorcode to exit with.public static Object setProperty(String key, String value)
key
- The key name for the property.value
- The value to associate with the key.
public static final String getDefaultProperty(String key)
public static final String getProperty(String key)
key
- The key of the property to get.
public static final String getProperty(String key, String defaultValue)
key
- The key of the property to get.defaultValue
- The default value to return when the key is not found.
public static final int getIntegerProperty(String key, int defaultValue)
public static final void setIntegerProperty(String name, int value)
name
- The propertyvalue
- The valuepublic static final boolean getBooleanProperty(String name, boolean defaultValue)
name
- The propertydefaultValue
- The default value of the propertypublic static final void setBooleanProperty(String name, boolean value)
name
- The propertyvalue
- The valuepublic static final Font getFontProperty(String name)
name
property, the font size is stored
in the namesize
property, and the font style is
stored in namestyle
. For example, if
name
is view.gutter.font
, the
properties will be named view.gutter.font
,
view.gutter.fontsize
, and
view.gutter.fontstyle
.
name
- The propertypublic static final Font getFontProperty(String name, Font def)
name
property, the font size is stored
in the namesize
property, and the font style is
stored in namestyle
. For example, if
name
is view.gutter.font
, the
properties will be named view.gutter.font
,
view.gutter.fontsize
, and
view.gutter.fontstyle
.
name
- The propertydef
- The default valuepublic static final void setFontProperty(String name, Font value)
name
property, the font size is stored
in the namesize
property, and the font style is
stored in namestyle
. For example, if
name
is view.gutter.font
, the
properties will be named view.gutter.font
,
view.gutter.fontsize
, and
view.gutter.fontstyle
.
name
- The propertyvalue
- The valuepublic static JARClassLoader getPluginLoader()
public static final boolean isExiting()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |