Changeset 7274

Timestamp:

Jan 24, 2017, 1:02:29 PM (6 years ago)

Author:

Nicklas Nordborg

Message:

References #2052: Add extension point for custom action in the Adminstrate->Services list

Added this to the documentation.

File:

• trunk/doc/src/docbook/developer/extensions.xml (modified) (1 diff)

trunk/doc/src/docbook/developer/extensions.xml

@@ -1946 +1946 @@
         http://baseplugins.thep.lu.se/wiki/net.sf.basedb.ftp</ulink>
       </para>
-      
+    </sect2>
+
+    <sect2 id="extensions_developer.service-actions">
+      <title>Service actions</title>
+      <para>
+        The services list page has an <guilabel>Action</guilabel> column
+        for showing the <guilabel>Start</guilabel> and <guilabel>Stop</guilabel>
+        actions as well as any other actions extending this extension point.
+        This extension point is similar to the toolbar extension points and actions
+        should implement the <interfacename 
+          docapi="net.sf.basedb.clients.web.extensions.toolbar">ButtonAction</interfacename>
+        interface. This extension point supports custom scripts and stylesheets. 
+        
+        Note that all extensions are invoked for all services. The 
+        <methodname>ClientContext.getItem()</methodname> returns the 
+        <interfacename docapi="net.sf.basedb.clients.web.extensions.service">ServiceControllerAction</interfacename>
+        instance for the current service. Extensions should use this to
+        decide if an action should be created or not.
+      </para>
     </sect2>