svn-gvsig-desktop / tags / v1_9_Build_1245 / docs / Andami / andami-api / com / iver / andami / plugins / Extension.html @ 40287
History | View | Annotate | Download (11.3 KB)
| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|---|---|
| 2 |
<!--NewPage-->
|
| 3 |
<HTML>
|
| 4 |
<HEAD>
|
| 5 |
<!-- Generated by javadoc (build 1.4.2_04) on Fri May 13 11:46:18 CEST 2005 -->
|
| 6 |
<TITLE>
|
| 7 |
Extension |
| 8 |
</TITLE>
|
| 9 |
|
| 10 |
<META NAME="keywords" CONTENT="com.iver.andami.plugins.Extension interface"> |
| 11 |
|
| 12 |
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| 13 |
|
| 14 |
<SCRIPT type="text/javascript"> |
| 15 |
function windowTitle() |
| 16 |
{
|
| 17 |
parent.document.title="Extension"; |
| 18 |
} |
| 19 |
</SCRIPT>
|
| 20 |
|
| 21 |
</HEAD>
|
| 22 |
|
| 23 |
<BODY BGCOLOR="white" onload="windowTitle();"> |
| 24 |
|
| 25 |
|
| 26 |
<!-- ========= START OF TOP NAVBAR ======= -->
|
| 27 |
<A NAME="navbar_top"><!-- --></A> |
| 28 |
<A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| 29 |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| 30 |
<TR>
|
| 31 |
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| 32 |
<A NAME="navbar_top_firstrow"><!-- --></A> |
| 33 |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| 34 |
<TR ALIGN="center" VALIGN="top"> |
| 35 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| 36 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| 37 |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| 38 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Extension.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| 39 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| 40 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| 41 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| 42 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| 43 |
</TR>
|
| 44 |
</TABLE>
|
| 45 |
</TD>
|
| 46 |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| 47 |
</EM>
|
| 48 |
</TD>
|
| 49 |
</TR>
|
| 50 |
|
| 51 |
<TR>
|
| 52 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| 53 |
PREV CLASS |
| 54 |
NEXT CLASS</FONT></TD> |
| 55 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| 56 |
<A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> |
| 57 |
<A HREF="Extension.html" target="_top"><B>NO FRAMES</B></A> |
| 58 |
<SCRIPT type="text/javascript"> |
| 59 |
<!--
|
| 60 |
if(window==top) {
|
| 61 |
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
| 62 |
}
|
| 63 |
//-->
|
| 64 |
</SCRIPT>
|
| 65 |
<NOSCRIPT>
|
| 66 |
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| 67 |
</NOSCRIPT>
|
| 68 |
|
| 69 |
</FONT></TD> |
| 70 |
</TR>
|
| 71 |
<TR>
|
| 72 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| 73 |
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| 74 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| 75 |
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| 76 |
</TR>
|
| 77 |
</TABLE>
|
| 78 |
<A NAME="skip-navbar_top"></A> |
| 79 |
<!-- ========= END OF TOP NAVBAR ========= -->
|
| 80 |
|
| 81 |
<HR>
|
| 82 |
<!-- ======== START OF CLASS DATA ======== -->
|
| 83 |
<H2>
|
| 84 |
<FONT SIZE="-1"> |
| 85 |
com.iver.andami.plugins</FONT>
|
| 86 |
<BR>
|
| 87 |
Interface Extension</H2>
|
| 88 |
<HR>
|
| 89 |
<DL>
|
| 90 |
<DT>public interface <B>Extension</B></DL> |
| 91 |
|
| 92 |
<P>
|
| 93 |
<p>
|
| 94 |
Una extensi?n es el mecanismo en la que los plugins pueden extender Andami. |
| 95 |
En la aplicaci?n habr? una instancia de cada extensi?n, las cuales tienen |
| 96 |
unos m?todos que ser?n ejecutados en respuesta a acciones del usuario. Las |
| 97 |
extensiones pueden a?adir controles a la interfaz de usuario. Pueden |
| 98 |
a?adir men?s y herramientas de la barra de herramientas, de forma que al |
| 99 |
ser seleccionadas se ejecute c?digo de la extensi?n. Adem?s de implementar esta |
| 100 |
interfaz, una extensi?n ha de tener un constructor vac?o, el cual ser? invocado |
| 101 |
para crear la instancia de la interfaz |
| 102 |
</p>
|
| 103 |
|
| 104 |
<p>
|
| 105 |
En un plugin correctamente implementado se crear? una instancia de cada |
| 106 |
extensi?n. Tras la creaci?n se invocar? al m?todo inicializar y luego con |
| 107 |
la aplicaci?n en marcha se invocar? a los m?todos isEnabled(), isVisible(), |
| 108 |
repetidas veces para controlar la activaci?n y visualizaci?n de los |
| 109 |
controles relacionados con la extensi?n. Cuando se ejecuta una extensi?n |
| 110 |
se ejecuta el metodo execute. Dicho m?todo se ejecuta en el thread de la |
| 111 |
interfaz de usuario, por lo que dejar? la interfaz bloqueada. Si se quiere |
| 112 |
dejar activa la interfaz se deber? lanzar un thread a parte. |
| 113 |
</p>
|
| 114 |
<P>
|
| 115 |
|
| 116 |
<P>
|
| 117 |
<HR>
|
| 118 |
|
| 119 |
<P>
|
| 120 |
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
| 121 |
|
| 122 |
|
| 123 |
<!-- =========== FIELD SUMMARY =========== -->
|
| 124 |
|
| 125 |
|
| 126 |
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
| 127 |
|
| 128 |
|
| 129 |
<!-- ========== METHOD SUMMARY =========== -->
|
| 130 |
|
| 131 |
<A NAME="method_summary"><!-- --></A> |
| 132 |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| 133 |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| 134 |
<TD COLSPAN=2><FONT SIZE="+2"> |
| 135 |
<B>Method Summary</B></FONT></TD> |
| 136 |
</TR>
|
| 137 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
| 138 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| 139 |
<CODE> void</CODE></FONT></TD> |
| 140 |
<TD><CODE><B><A HREF="../../../../com/iver/andami/plugins/Extension.html#execute(java.lang.String)">execute</A></B>(java.lang.String actionCommand)</CODE> |
| 141 |
|
| 142 |
<BR>
|
| 143 |
M?todo que se ejecuta cuando el usuario acciona un control de la |
| 144 |
extensi?n</TD>
|
| 145 |
</TR>
|
| 146 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
| 147 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| 148 |
<CODE> void</CODE></FONT></TD> |
| 149 |
<TD><CODE><B><A HREF="../../../../com/iver/andami/plugins/Extension.html#inicializar()">inicializar</A></B>()</CODE> |
| 150 |
|
| 151 |
<BR>
|
| 152 |
C?digo de inicializaci?n de la extension.</TD> |
| 153 |
</TR>
|
| 154 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
| 155 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| 156 |
<CODE> boolean</CODE></FONT></TD> |
| 157 |
<TD><CODE><B><A HREF="../../../../com/iver/andami/plugins/Extension.html#isEnabled()">isEnabled</A></B>()</CODE> |
| 158 |
|
| 159 |
<BR>
|
| 160 |
Este m?todo es invocado por la aplicaci?n para habilitar o desabilitar |
| 161 |
el estado de los controles (men?s y botones de la barra de |
| 162 |
herramientas) que ejecutan el c?digo de la extensi?n.</TD>
|
| 163 |
</TR>
|
| 164 |
<TR BGCOLOR="white" CLASS="TableRowColor"> |
| 165 |
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| 166 |
<CODE> boolean</CODE></FONT></TD> |
| 167 |
<TD><CODE><B><A HREF="../../../../com/iver/andami/plugins/Extension.html#isVisible()">isVisible</A></B>()</CODE> |
| 168 |
|
| 169 |
<BR>
|
| 170 |
Este m?todo es invocado por la aplicaci?n para mostrar o esconder los |
| 171 |
controles (men?s y botones de la barra de herramientas) que ejecutan |
| 172 |
el c?digo de la extensi?n.</TD>
|
| 173 |
</TR>
|
| 174 |
</TABLE>
|
| 175 |
|
| 176 |
<P>
|
| 177 |
|
| 178 |
<!-- ============ FIELD DETAIL =========== -->
|
| 179 |
|
| 180 |
|
| 181 |
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
| 182 |
|
| 183 |
|
| 184 |
<!-- ============ METHOD DETAIL ========== -->
|
| 185 |
|
| 186 |
<A NAME="method_detail"><!-- --></A> |
| 187 |
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| 188 |
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| 189 |
<TD COLSPAN=1><FONT SIZE="+2"> |
| 190 |
<B>Method Detail</B></FONT></TD> |
| 191 |
</TR>
|
| 192 |
</TABLE>
|
| 193 |
|
| 194 |
<A NAME="inicializar()"><!-- --></A><H3> |
| 195 |
inicializar</H3>
|
| 196 |
<PRE>
|
| 197 |
public void <B>inicializar</B>()</PRE> |
| 198 |
<DL>
|
| 199 |
<DD>C?digo de inicializaci?n de la extension.
|
| 200 |
<P>
|
| 201 |
<DD><DL> |
| 202 |
</DL>
|
| 203 |
</DD>
|
| 204 |
</DL>
|
| 205 |
<HR>
|
| 206 |
|
| 207 |
<A NAME="execute(java.lang.String)"><!-- --></A><H3> |
| 208 |
execute</H3>
|
| 209 |
<PRE>
|
| 210 |
public void <B>execute</B>(java.lang.String actionCommand)</PRE> |
| 211 |
<DL>
|
| 212 |
<DD>M?todo que se ejecuta cuando el usuario acciona un control de la
|
| 213 |
extensi?n |
| 214 |
<P>
|
| 215 |
<DD><DL> |
| 216 |
<DT><B>Parameters:</B><DD><CODE>actionCommand</CODE> - DOCUMENT ME! |
| 217 |
<DT><B>Throws:</B> |
| 218 |
<DD><CODE>java.lang.Throwable</CODE> - DOCUMENT ME!</DL> |
| 219 |
</DD>
|
| 220 |
</DL>
|
| 221 |
<HR>
|
| 222 |
|
| 223 |
<A NAME="isEnabled()"><!-- --></A><H3> |
| 224 |
isEnabled</H3>
|
| 225 |
<PRE>
|
| 226 |
public boolean <B>isEnabled</B>()</PRE> |
| 227 |
<DL>
|
| 228 |
<DD>Este m?todo es invocado por la aplicaci?n para habilitar o desabilitar
|
| 229 |
el estado de los controles (men?s y botones de la barra de |
| 230 |
herramientas) que ejecutan el c?digo de la extensi?n. |
| 231 |
<P>
|
| 232 |
<DD><DL> |
| 233 |
|
| 234 |
<DT><B>Returns:</B><DD>true si el c?digo debe estar habilitado y false en caso |
| 235 |
contrario</DL>
|
| 236 |
</DD>
|
| 237 |
</DL>
|
| 238 |
<HR>
|
| 239 |
|
| 240 |
<A NAME="isVisible()"><!-- --></A><H3> |
| 241 |
isVisible</H3>
|
| 242 |
<PRE>
|
| 243 |
public boolean <B>isVisible</B>()</PRE> |
| 244 |
<DL>
|
| 245 |
<DD>Este m?todo es invocado por la aplicaci?n para mostrar o esconder los
|
| 246 |
controles (men?s y botones de la barra de herramientas) que ejecutan |
| 247 |
el c?digo de la extensi?n. |
| 248 |
<P>
|
| 249 |
<DD><DL> |
| 250 |
|
| 251 |
<DT><B>Returns:</B><DD>true si el c?digo debe estar visibles y false en caso contrario</DL> |
| 252 |
</DD>
|
| 253 |
</DL>
|
| 254 |
<!-- ========= END OF CLASS DATA ========= -->
|
| 255 |
<HR>
|
| 256 |
|
| 257 |
|
| 258 |
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
| 259 |
<A NAME="navbar_bottom"><!-- --></A> |
| 260 |
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| 261 |
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| 262 |
<TR>
|
| 263 |
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| 264 |
<A NAME="navbar_bottom_firstrow"><!-- --></A> |
| 265 |
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| 266 |
<TR ALIGN="center" VALIGN="top"> |
| 267 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| 268 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| 269 |
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| 270 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Extension.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| 271 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| 272 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| 273 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| 274 |
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| 275 |
</TR>
|
| 276 |
</TABLE>
|
| 277 |
</TD>
|
| 278 |
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| 279 |
</EM>
|
| 280 |
</TD>
|
| 281 |
</TR>
|
| 282 |
|
| 283 |
<TR>
|
| 284 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| 285 |
PREV CLASS |
| 286 |
NEXT CLASS</FONT></TD> |
| 287 |
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| 288 |
<A HREF="../../../../index.html" target="_top"><B>FRAMES</B></A> |
| 289 |
<A HREF="Extension.html" target="_top"><B>NO FRAMES</B></A> |
| 290 |
<SCRIPT type="text/javascript"> |
| 291 |
<!--
|
| 292 |
if(window==top) {
|
| 293 |
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
|
| 294 |
}
|
| 295 |
//-->
|
| 296 |
</SCRIPT>
|
| 297 |
<NOSCRIPT>
|
| 298 |
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| 299 |
</NOSCRIPT>
|
| 300 |
|
| 301 |
</FONT></TD> |
| 302 |
</TR>
|
| 303 |
<TR>
|
| 304 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| 305 |
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| 306 |
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| 307 |
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| 308 |
</TR>
|
| 309 |
</TABLE>
|
| 310 |
<A NAME="skip-navbar_bottom"></A> |
| 311 |
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
| 312 |
|
| 313 |
<HR>
|
| 314 |
|
| 315 |
</BODY>
|
| 316 |
</HTML>
|