classe_ajuda-js.html
12.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Ajuda - i3Geo</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/prettify.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.51 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CSection"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="Ajuda"></a>Ajuda</h1><div class=CBody><p>Manipulação das mensagens de ajuda.</p><p>Permite definir a mensagem padrão da janela de mensagens. Abrir a janela e definir seu conteúdo. Controla também o letreiro móvel que mostra mensagens especiais definidas em cada layer adicionado ao mapa.</p><h4 class=CHeading>Namespace</h4><p>i3GEO.ajuda</p><h4 class=CHeading>Exemplos</h4><p>Se vc não quiser que a janela de ajuda seja aberta, inclua em seu HTML ou javascript</p><p>i3GEO.ajuda.ATIVAJANELA = false;</p><p>Para enviar uma mensagem para a janela (quando estiver aberta), utilize</p><p>i3GEO.ajuda.mostraJanela(“texto”);</p><h4 class=CHeading>Veja</h4><p><a href="http://localhost/i3geo/classesjs/classe_ajuda.js" class=LURL target=_top>http://localhost/i3geo/classesjs/classe_ajuda.js</a></p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#Ajuda" >Ajuda</a></td><td class=SDescription>Manipulação das mensagens de ajuda.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Propriedades" >Propriedades</a></td><td class=SDescription></td></tr><tr class="SPropriedade SIndent2 SMarked"><td class=SEntry><a href="#ATIVAJANELA" >ATIVAJANELA</a></td><td class=SDescription>Define se a janela de mensagens pode ou não ser aberta.</td></tr><tr class="SPropriedade SIndent2"><td class=SEntry><a href="#DIVAJUDA" >DIVAJUDA</a></td><td class=SDescription>Nome do elemento HTML, do tipo DIV, que irá conter os textos de ajuda.</td></tr><tr class="SPropriedade SIndent2 SMarked"><td class=SEntry><a href="#DIVLETREIRO" >DIVLETREIRO</a></td><td class=SDescription>Id do elemento HTML onde será incluído o banner (letreiro) de mensagens.</td></tr><tr class="SPropriedade SIndent2"><td class=SEntry><a href="#MENSAGEMPADRAO" >MENSAGEMPADRAO</a></td><td class=SDescription>Mensagem que será incluída ao iniciar a janela de mensagens ou quando não houver mensagem definida para o elemento sobre o qual o mouse estaciona.</td></tr><tr class="SPropriedade SIndent2 SMarked"><td class=SEntry><a href="#TRANSICAOSUAVE" >TRANSICAOSUAVE</a></td><td class=SDescription>Altera a transparência quando o mouse sobrepõe a janela e quando sai</td></tr><tr class="SPropriedade SIndent2"><td class=SEntry><a href="#OPACIDADE" >OPACIDADE</a></td><td class=SDescription>Valor da opacidade mínima utilizada quando TRANSICAOSUAVE for igual a true.</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#abreDoc" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">abreDoc</a></td><td class=SDescription>Abre a documentacao do i3geo em uma nova janela do navegador</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#abreJanela" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">abreJanela</a></td><td class=SDescription>Abre a janela flutuante para mostrar as mensagens de ajuda.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#fechaJanela" >fechaJanela.</a></td><td class=SDescription>Fecha a janela de ajuda.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#mostraJanela" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">mostraJanela</a></td><td class=SDescription>Mostra um texto dentro da janela de mensagens padrão.</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#mostraLetreiro" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">mostraLetreiro</a></td><td class=SDescription>Preenche o elemento INPUT com a mensagem de texto e faz a movimentação das letras.</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#redesSociais" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">redesSociais</a></td><td class=SDescription>Abre uma janela com informações sobre a presença do i3Geo em redes sociais</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Propriedades"></a>Propriedades</h3></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="ATIVAJANELA"></a>ATIVAJANELA</h3><div class=CBody><p>Define se a janela de mensagens pode ou não ser aberta.</p><h4 class=CHeading>Tipo</h4><p>{Boolean}</p><h4 class=CHeading>Default</h4><p>true</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="DIVAJUDA"></a>DIVAJUDA</h3><div class=CBody><p>Nome do elemento HTML, do tipo DIV, que irá conter os textos de ajuda.</p><p>Se esse DIV for encontrado no mapa, os textos serão mostrados em seu interior.</p><h4 class=CHeading>Tipo</h4><p>{String}</p><h4 class=CHeading>Default</h4><p>i3geo_ajuda</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="DIVLETREIRO"></a>DIVLETREIRO</h3><div class=CBody><p>Id do elemento HTML onde será incluído o banner (letreiro) de mensagens.</p><p>Esse tipo de mensagem é obtida do METADATA “MENSAGEM” que pode ser incluído em um layer.</p><p>Tipo</p><p>{String}</p><h4 class=CHeading>Default</h4><p>i3geo_letreir</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="MENSAGEMPADRAO"></a>MENSAGEMPADRAO</h3><div class=CBody><p>Mensagem que será incluída ao iniciar a janela de mensagens ou quando não houver mensagem definida para o elemento sobre o qual o mouse estaciona.</p><p>Tipo</p><p>{String}</p><h4 class=CHeading>Default</h4><p>$trad(“p1”)</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="TRANSICAOSUAVE"></a>TRANSICAOSUAVE</h3><div class=CBody><p>Altera a transparência quando o mouse sobrepõe a janela e quando sai</p><p>Tipo</p><p>{boolean}</p><h4 class=CHeading>Default</h4><p>true</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="OPACIDADE"></a>OPACIDADE</h3><div class=CBody><p>Valor da opacidade mínima utilizada quando TRANSICAOSUAVE for igual a true.</p><p>Varia de 0 a 100</p><p>Tipo</p><p>{numeric}</p><h4 class=CHeading>Default</h4><p>20</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="abreDoc"></a>abreDoc</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>abreDoc : function(</td><td class="PParameter prettyprint " nowrap>url</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Abre a documentacao do i3geo em uma nova janela do navegador</p><h4 class=CHeading>Parametro</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>{string}</td><td class=CDLDescription>url que será adicionada a i3GEO.configura.locaplic</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="abreJanela"></a>abreJanela</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">abreJanela : function()</td></tr></table></blockquote><p>Abre a janela flutuante para mostrar as mensagens de ajuda.</p><p>Essa função é executada na inicialização do i3GEO</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="fechaJanela"></a>fechaJanela.</h3><div class=CBody><p>Fecha a janela de ajuda.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mostraJanela"></a>mostraJanela</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mostraJanela : function(</td><td class="PParameter prettyprint " nowrap>texto</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Mostra um texto dentro da janela de mensagens padrão.</p><h4 class=CHeading>Parametro</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>{String}</td><td class=CDLDescription>texto a ser mostrado</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="mostraLetreiro"></a>mostraLetreiro</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mostraLetreiro : function()</td></tr></table></blockquote><p>Preenche o elemento INPUT com a mensagem de texto e faz a movimentação das letras.</p><p>O aparecimento das letras é controlado por um temporizador e as mensagens são mostradas apenas duas vezes, desde o início do redesenho do mapa.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="redesSociais"></a>redesSociais</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">redesSociais : function()</td></tr></table></blockquote><p>Abre uma janela com informações sobre a presença do i3Geo em redes sociais</p></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>abreDoc : function(</td><td class="PParameter prettyprint " nowrap>url</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Abre a documentacao do i3geo em uma nova janela do navegador</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">abreJanela : function()</td></tr></table></blockquote>Abre a janela flutuante para mostrar as mensagens de ajuda.</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>mostraJanela : function(</td><td class="PParameter prettyprint " nowrap>texto</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Mostra um texto dentro da janela de mensagens padrão.</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">mostraLetreiro : function()</td></tr></table></blockquote>Preenche o elemento INPUT com a mensagem de texto e faz a movimentação das letras.</div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">redesSociais : function()</td></tr></table></blockquote>Abre uma janela com informações sobre a presença do i3Geo em redes sociais</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>