<?xml version="1.0"?>
<?xml-stylesheet href="http://xslt.fourthought.com/api.xslt" type="text/xsl"?>
<tech:ApiSpec title="4XLink API"
  xmlns:tech="http://namespaces.fourthought.com/technical"
  xmlns:dc= "http://purl.org/dc/elements/1.1"
  xmlns="http://docbook.org/docbook/xml/4.0/namespace"
>

<dc:Title>4XLink API</dc:Title>
<dc:Subject>XLink</dc:Subject>
<dc:Subject>API</dc:Subject>
<dc:Subject>4XLink</dc:Subject>
<dc:Description>Application Programming Interface for 4XLink.</dc:Description>


<sect1><title>Usage</title>
<para>
4XLink provides a processor that can be instansiated and used to acuate simple and extended "onLoad" XLinks.
</para>
</sect1>



<sect1><title>API</title>

<tech:Module>
  <tech:Name>Ft.XLink</tech:Name>
  <tech:Desc>The 4XLink Module</tech:Desc>

  <tech:Class>
    <tech:Name>Processor</tech:Name>
    <tech:Desc>The XLink Processor</tech:Desc>
    <tech:Method>
      <tech:Name>runString</tech:Name>
      <tech:Desc>Expand all XLinks in a XML string</tech:Desc>
      <tech:Arg>
        <tech:Name>source</tech:Name>
        <tech:Desc>The string representing the source document</tech:Desc>
        <tech:Type>string conforming to the XML specification</tech:Type>
      </tech:Arg>
      <tech:Arg>
        <tech:Name>reader</tech:Name>
        <tech:Type>object supporting the xml.dom.ext.reader.Reader interface</tech:Type>
        <tech:Desc>Used to read the string into DOM format</tech:Desc>
        <tech:Default>None</tech:Default>
      </tech:Arg>
      <tech:Return>
        <tech:Type>a DOM node</tech:Type>
        <tech:Desc>The transformed document</tech:Desc>
      </tech:Return>
    </tech:Method>
    <tech:Method>
      <tech:Name>runUri</tech:Name>
      <tech:Desc>Expand all XLinks in the resource referenced by the URI</tech:Desc>
      <tech:Arg>
        <tech:Name>uri</tech:Name>
        <tech:Desc>The resource to expand links in</tech:Desc>
        <tech:Type>string conforming to the URI specification</tech:Type>
      </tech:Arg>
      <tech:Arg>
        <tech:Name>reader</tech:Name>
        <tech:Type>object supporting the  Reader interface</tech:Type>
        <tech:Desc>Used to read the string into DOM format</tech:Desc>
        <tech:Default>None</tech:Default>
      </tech:Arg>
      <tech:Return>
        <tech:Type>a DOM node</tech:Type>
        <tech:Desc>The transformed document</tech:Desc>
      </tech:Return>
    </tech:Method>
  </tech:Class>
</tech:Module>

</sect1>

</tech:ApiSpec>
