Module tagtraum.japlse

Package com.tagtraum.macos.systemevents

Interface XmlData

All Superinterfaces:

Reference

@Code("xmld")
@Name("XML data")
public interface XmlData
extends Reference

Data in XML format.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
default int	countXmlElements()
int	countXmlElements(String filter)
String	getId()	The unique identifier of the XML data.
String	getName()	The name of the XML data.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
String	getText()	The text representation of the XML data.
XmlElement	getXmlElement(int index)
XmlElement	getXmlElement(Id id)
default XmlElement[]	getXmlElements()
XmlElement[]	getXmlElements(String filter)
void	setName(String name)	The name of the XML data.
void	setText(String text)	The text representation of the XML data.

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getXmlElements

@Kind("element")
@Type("XML element")
default XmlElement[] getXmlElements()

Returns:

an array of all XmlElements

getXmlElements

@Kind("element")
@Type("XML element")
XmlElement[] getXmlElements(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

an array of all XmlElements

getXmlElement

@Kind("element")
@Type("XML element")
XmlElement getXmlElement(int index)

Parameters:

index - index into the element list (zero-based)

Returns:

the XmlElement at the requested index

getXmlElement

@Kind("element")
@Type("XML element")
XmlElement getXmlElement(Id id)

Parameters:

id - id of the item

Returns:

the XmlElement with the requested id

countXmlElements

@Kind("element")
@Type("XML element")
default int countXmlElements()

Returns:

number of all XmlElements

countXmlElements

@Kind("element")
@Type("XML element")
int countXmlElements(String filter)

Parameters:

filter - AppleScript filter clause without the leading "whose" or "where"

Returns:

the number of elements that pass the filter

getId

@Code("ID  ")
@Kind("property")
@Name("id")
@Type("text")
String getId()

The unique identifier of the XML data.

Returns:

property value

getName

@Code("pnam")
@Kind("property")
@Name("name")
@Type("text")
String getName()

The name of the XML data.

Returns:

property value

setName

@Code("pnam")
@Kind("property")
@Name("name")
@Type("text")
void setName(String name)

The name of the XML data.

Parameters:

name - new property value

getText

@Code("ctxt")
@Kind("property")
@Name("text")
@Type("text")
String getText()

The text representation of the XML data.

Returns:

property value

setText

@Code("ctxt")
@Kind("property")
@Name("text")
@Type("text")
void setText(String text)

The text representation of the XML data.

Parameters:

text - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties