com.github.jferard.fastods.odselement

Class ScriptEventListener

java.lang.Object

com.github.jferard.fastods.odselement.ScriptEventListener

All Implemented Interfaces:

XMLConvertible

public class ScriptEventListener
extends Object
implements XMLConvertible

14.4.2 script:event-listener

Author:

J. Férard

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASIC_LANG For scripts in Basic
static String	JAVA_LANG For scripts in Java
static String	JAVASCRIPT_LANG For scripts in JavaScript
static String	PYTHON_LANG For scripts in Python

Constructor Summary

Constructors

Constructor and Description
ScriptEventListener(String genericLanguage, ScriptEvent event, String functionName, String language)

Method Summary

Modifier and Type	Method and Description
void	appendXMLContent(XMLUtil util, Appendable appendable) Write the XML format for this object.
static ScriptEventListenerBuilder	builder(ScriptEvent event, String functionName)
static ScriptEventListener	create(ScriptEvent event, String functionName)

Methods inherited from class java.lang.Object

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

Field Detail

BASIC_LANG

public static final String BASIC_LANG

For scripts in Basic

See Also:

Constant Field Values

PYTHON_LANG

public static final String PYTHON_LANG

For scripts in Python

See Also:

Constant Field Values

JAVA_LANG

public static final String JAVA_LANG

For scripts in Java

See Also:

Constant Field Values

JAVASCRIPT_LANG

public static final String JAVASCRIPT_LANG

For scripts in JavaScript

See Also:

Constant Field Values

Constructor Detail

ScriptEventListener

public ScriptEventListener(String genericLanguage,
                           ScriptEvent event,
                           String functionName,
                           String language)

Parameters:

genericLanguage - ooo:script

event - the event, e.g dom:load

functionName - the function, e.g Standard.Module1.Main

language - Basic, Python, ...

Method Detail

create

public static ScriptEventListener create(ScriptEvent event,
                                         String functionName)

Parameters:

event - the event, e.g dom:load

functionName - the function, e.g Standard.Module1.Main

Returns:

a new listener

builder

public static ScriptEventListenerBuilder builder(ScriptEvent event,
                                                 String functionName)

Parameters:

event - the event, e.g dom:load

functionName - the function, e.g Standard.Module1.Main

Returns:

a new listener

appendXMLContent

public void appendXMLContent(XMLUtil util,
                             Appendable appendable)
                      throws IOException

Description copied from interface: XMLConvertible

Write the XML format for this object. This is used while writing the ODS file.

Specified by:

appendXMLContent in interface XMLConvertible

Parameters:

util - a helper object

appendable - the appendable to append data to

Throws:

IOException - if the style can't be added