Serge NOEL
82 lines
3.8 KiB
Plaintext
82 lines
3.8 KiB
Plaintext
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta name="generator" content="HTML Tidy for HTML5 for Apple macOS version 5.8.0">
|
|
<!-- Copyright 2008 -->
|
|
|
|
<title>JMRI: Frame Servlet</title><!--#include virtual="/help/en/parts/Style.shtml" -->
|
|
</head>
|
|
<body>
|
|
<!--#include virtual="/help/en/parts/Header.shtml" -->
|
|
|
|
<div id="mBody">
|
|
<!--#include virtual="Sidebar.shtml" -->
|
|
|
|
<div id="mainContent">
|
|
<h1>JMRI: Frame Servlet</h1>
|
|
|
|
<p>The JMRI Frame Servlet provides web access to JMRI windows. Its base url is "/frame/",
|
|
which by itself will return a page listing available frames.</p>
|
|
|
|
<p>It uses the facilities of the <code>jmri.util.JmriJFrame</code> class to locate windows
|
|
and create an image of their current appearance. The window does not have to be maximized,
|
|
but it does have to be open; it's OK for the window to have been minimized.</p>
|
|
|
|
<p>The <a href="index.shtml#Configure">Web Server Preferences</a> can be used to adjust the
|
|
default delay after a click and adjust the periodic refresh between clicks. You can also
|
|
enter a list of frames which are not to be allowed, and enable ajax refresh (recommended) or
|
|
use the older meta-refresh.</p>
|
|
|
|
<p>You can override the defaults for individual pages by adding the following yes/no
|
|
parameters to your URL:</p>
|
|
|
|
<ul>
|
|
<li><strong>plain</strong> (hide the footer links)</li>
|
|
|
|
<li><strong>protect</strong> (protect the frame from user clicks, i.e. read-only image, but
|
|
with refresh)</li>
|
|
|
|
<li><strong>ajax</strong> (use ajax for updates)</li>
|
|
</ul>
|
|
To display any <em>already open</em> JMRI window as a <strong>clickable</strong> image that
|
|
periodically refreshes, use a URL like: <code><a href=
|
|
"http://127.0.0.1:12080/frame/Monitor%20Slots.html">http://127.0.0.1:12080/frame/Monitor%20Slots.html</a></code><br>
|
|
|
|
<code><a href=
|
|
"http://127.0.0.1:12080/frame/Analog%20Clock.html">http://127.0.0.1:12080/frame/Analog%20Clock.html</a></code><br>
|
|
|
|
<code><a href=
|
|
"http://127.0.0.1:12080/frame/Turnout%20Table.html">http://127.0.0.1:12080/frame/Turnout%20Table.html</a></code>
|
|
<p>Note the frame title in the URL, followed by ".html". Replace any spaces in the title with
|
|
"%20".</p>
|
|
For current, dynamically-generated list of available windows, use this URL: <code><a href=
|
|
"http://127.0.0.1:12080/frame">http://127.0.0.1:12080/frame</a></code>
|
|
<p><em>Note:</em> Adjust defaults such as refresh timing, disallowed frames and ajax usage in
|
|
Web Server Preferences.</p>
|
|
You can override the defaults for individual pages by using the following parameters in your
|
|
URL:
|
|
<ul>
|
|
<li><strong>plain</strong> (hide the footer links)</li>
|
|
|
|
<li><strong>protect</strong> (protect the frame from user clicks, i.e. read-only image, but
|
|
with refresh)</li>
|
|
|
|
<li><strong>ajax</strong> (use ajax for updates)</li>
|
|
</ul>
|
|
Example, showing no links, protected, using ajax to refresh every 12 seconds:<br>
|
|
<code><a href=
|
|
"http://127.0.0.1:12080/frame/Power%20Control.html?ajax=true&plain=true&protect=true&retry=12">
|
|
http://127.0.0.1:12080/frame/Power%20Control.html?ajax=true&plain=true&protect=true&retry=12</a></code>
|
|
<p>The <code>jmri/web/servlet/frameimage/JmriJFrameServlet.properties</code> <a href=
|
|
"https://github.com/JMRI/JMRI/blob/master/java/src/jmri/web/servlet/frameimage/JmriJFrameServlet.properties">
|
|
properties file</a> can be used to configure the HTML that's returned when a frame is
|
|
requested.</p>
|
|
<!--#include virtual="/help/en/parts/Footer.shtml" -->
|
|
</div>
|
|
<!-- closes #mainContent-->
|
|
</div>
|
|
<!-- closes #mBody-->
|
|
<script src="/js/help.js"></script>
|
|
</body>
|
|
</html>
|