<html> <head> <title>Service UnoControlRoadmapModel</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="UnoControlRoadmapModel-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">awt</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">service UnoControlRoadmapModel</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies the standard model of an <a href="UnoControlContainer.html">UnoControlContainer</a>. </dd> </dl> </td> </tr> </table> <hr> <a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</td> </tr> <tr> <td class="imsum_left"><a href="UnoControlModel.html">UnoControlModel</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies the standard model of an <a href="UnoControl.html">UnoControl</a> in the <em>Smalltalk model view controller design</em>. </dd> </dl> </td> </tr> </table> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../container/module-ix.html">container</a>::<a href="../container/XIndexContainer.html">XIndexContainer</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>The control serves as an indexed container typically for RoadmapItems as specified in com::sun::star::awt:RoadmapItem. The RoadmapItems are held in a sequence. When inserting such items their ID is set equal to the Index of their insertion by default. After removing items the CurrentItem property is - when beyound the upper sequence boundaries - set equal to last index of the RoadmapItem Array. </dd> </dl> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">long<br> <a href="#BackgroundColor">BackgroundColor</a></td> <td class="imsum_right">specifies the background color (RGB) of the control. The Default value is white </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Interactive">Interactive</a></td> <td class="imsum_right">determines whether the control is interactive or not. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Complete">Complete</a></td> <td class="imsum_right">determines whether the control container is complete or not. If it is false than a non - interactive RoadmapItem is appended </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#ImageURL">ImageURL</a></td> <td class="imsum_right">specifies an URL to an image to use for the control. The image is placed in the lower right corner of the control </td> </tr> <tr> <td class="imsum_left">[ transient ] ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a><br> <a href="#Graphic">Graphic</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies a graphic to be displayed on the control </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#Border">Border</a></td> <td class="imsum_right">specifies the border style of the control. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Printable">Printable</a></td> <td class="imsum_right">specifies whether the control will be printed with the document. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Text">Text</a></td> <td class="imsum_right">specifies the text displayed in the control. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#CurrentItemID">CurrentItemID</a></td> <td class="imsum_right">refers to the ID of the currently selected item. Initially this property is set to '-1' which is equal to 'undefined" If the Roadmap Item that the CurrentItemID refers to is removed the property 'CurrentItemID' is set to -1 </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HelpText">HelpText</a></td> <td class="imsum_right">specifies the help text of the control. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HelpURL">HelpURL</a></td> <td class="imsum_right">specifies the help URL of the control. </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="BackgroundColor" class="membertitle">BackgroundColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>BackgroundColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the background color (RGB) of the control. The Default value is white </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Interactive" class="membertitle">Interactive</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Interactive</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the control is interactive or not. </dd> <dd><p>A roadmap control which is interactive allows selecting its items out-of-order, by simply clicking them.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Complete" class="membertitle">Complete</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Complete</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the control container is complete or not. If it is false than a non - interactive RoadmapItem is appended </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ImageURL" class="membertitle">ImageURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>ImageURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies an URL to an image to use for the control. The image is placed in the lower right corner of the control </dd> <dt><b>See also</b></dt> <dd><a href="#Graphic">Graphic</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Graphic" class="membertitle">Graphic</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>[ transient ] ::com::sun::star::<a href="../graphic/module-ix.html">graphic</a>::<a href="../graphic/XGraphic.html">XGraphic</a> <b>Graphic</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies a graphic to be displayed on the control </dd> <dd><p>If this property is present, it interacts with the <a href="#ImageURL">ImageURL</a>in the following way: <ul><li>If <a href="#ImageURL">ImageURL</a> is set, <a href="#Graphic">Graphic</a> will be reset to an object as loaded from the given image URL, or <b>NULL</b> if <a href="#ImageURL">ImageURL</a> does not point to a valid image file.</li> <li>If <a href="#Graphic">Graphic</a> is set, <a href="#ImageURL">ImageURL</a> will be reset to an empty string.</li> </ul></p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Border" class="membertitle">Border</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Border</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the border style of the control. </dd> <dd><pre> 0: No border 1: 3D border 2: simple border </pre> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Printable" class="membertitle">Printable</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Printable</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies whether the control will be printed with the document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Text" class="membertitle">Text</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Text</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the text displayed in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CurrentItemID" class="membertitle">CurrentItemID</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>CurrentItemID</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>refers to the ID of the currently selected item. Initially this property is set to '-1' which is equal to 'undefined" If the Roadmap Item that the CurrentItemID refers to is removed the property 'CurrentItemID' is set to -1 </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HelpText" class="membertitle">HelpText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>HelpText</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the help text of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HelpURL" class="membertitle">HelpURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>HelpURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the help URL of the control. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>