3.13. ARender Plugins

ARender allow to integrate plugins. They can be opened in two different ways:

  • Direct opening from the ARender URL with the parameter plugin=pluginName
  • Opening from ARender by events (Button press/configuration)

3.13.1. Plugins XML configuration

If you use the button mode to launch your plugin, you have to make a configuration of it in toppanel-configuration.xml :

<bean id="topPanel" class="com.arondor.viewer.client.toppanel.TopPanel">
            <property name="containedWidgets">
                    <list>
                        ...
                        <ref bean="plumeButton" />
                    </list>
            </property>
            <property name="moreButton">
                    <ref bean="moreButton" />
            </property>
    </bean>
    ...
<bean id="plumeButton"
            class="com.arondor.viewer.client.toppanel.presenter.ButtonPresenter"
            scope="prototype">
            <property name="enabled" value="true" />
            <property name="imageResource">
                    <bean
                            class="com.arondor.viewer.client.defferedmodules.ExternalImageResource">
                            <property name="width" value="32" />
                            <property name="height" value="32" />
                            <property name="url" value="icons/plume.png" />
                    </bean>
            </property>
            <property name="buttonTitle">
                    <value>Plume</value>
            </property>
            <property name="buttonHandler">
                    <bean
                            class="com.arondor.viewer.client.toppanel.behavior.document.GenericHandler">
                            <constructor-arg>
                                    <bean
                                            class="com.arondor.viewer.client.events.document.AskOpenPluginEvent">
                                            <constructor-arg>
                                                    <value>plume</value>
                                            </constructor-arg>
                                            <property name="openInMultiView" value="true" />
                                    </bean>
                            </constructor-arg>
                    </bean>
            </property>
    </bean>

The important configuration points in this example are :

  • openInMultiView announces to ARender that the plugin can be opened in multiView and not in full window.
  • AskOpenPluginEvent possess a constructor-arg that refers the pluginName defined in the server side XML.

In order to configure the plugin itself, it is important to add the configuration either in arender-plugin.xml or in a separate file, referenced in the arender-plugin.xml.

Example of arender-plugin.xml :

<?xml version="1.0" encoding="UTF-8"?>

<beans default-lazy-init="true" default-autowire="no"
        xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd">

        <!-- xml imported by ARender, please add any plugins you wish to import in this file -->
        <import resource="plume.xml"/>
</beans>

With an example plume.xml:

<?xml version="1.0" encoding="UTF-8"?>

<beans default-lazy-init="true" default-autowire="no"
        xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
        http://www.springframework.org/schema/beans/spring-beans.xsd">

        <bean id="plume" class="com.arondor.viewer.common.plugin.Plugin">
                <property name="iframeSrc" value="http://plume.arender.fr/" />
        </bean>
</beans>

Please observe the configuration of the class com.arondor.viewer.common.plugin.Plugin where we use the property iframeSrc. This property allows to setup and iframe source URL in case the plugin refers to an existing webpage. This webpage will then be integrated into ARender as an iframe.

The listing of the different configuration modes are the following :

  • iframeSrc : specifies the source of the URL of the iframe integrating the plugin. This implies the iframe mode.
  • html : specifies the HTML content of the plugin. This allow a total control of the plugin integration but remove the parameterizing by javascript calls.
  • innerHTML : specifies the inner HTML content of the plugin. This allows to put an empty iframe source but with inner HTML contents.