classe_guias-js.html
17.9 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
51
52
53
54
55
56
57
58
59
60
61
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Guias - 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="Guias"></a>Guias</h1><div class=CBody><p>Cria e controla os blocos de opções ativados por meio de guias ou botões</p><p>As guias alternam conteúdos para exibição conforme as escolhas feitas pelo usuário</p><h4 class=CHeading>Namespace</h4><p>i3GEO.guias</p><h4 class=CHeading>Veja</h4><p><a href="http://localhost/i3geo/classesjs/classe_guias.js" class=LURL target=_top>http://localhost/i3geo/classesjs/classe_guias.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="#Guias" >Guias</a></td><td class=SDescription>Cria e controla os blocos de opções ativados por meio de guias ou botões</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Variaveis" >Variaveis</a></td><td class=SDescription></td></tr><tr class="SVariavel SIndent2 SMarked"><td class=SEntry><a href="#ATUAL" >ATUAL</a></td><td class=SDescription>Guia que está ativa ou que será ativada ao iniciar o mapa</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="#ALTURACORPOGUIAS" >ALTURACORPOGUIAS</a></td><td class=SDescription>Altura em pixels que será aplicado em cada guia</td></tr><tr class="SPropriedade SIndent2"><td class=SEntry><a href="#CONFIGURA" >CONFIGURA</a></td><td class=SDescription>Define os parâmetros de cada guia que será mostrada no mapa, como título, conteúdo, etc.</td></tr><tr class="SPropriedade SIndent2 SMarked"><td class=SEntry><a href="#ORDEM" >ORDEM</a></td><td class=SDescription>Ordem de inclusão das guias no mapa. </td></tr><tr class="SPropriedade SIndent2"><td class=SEntry><a href="#TIPO" >TIPO</a></td><td class=SDescription>Tipo de guia</td></tr><tr class="SPropriedade SIndent2 SMarked"><td class=SEntry><a href="#idguias" >idguias</a></td><td class=SDescription>ID do elemento DOM, criado pelo YUI, onde serão inseridas as guias</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="#cria" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">cria</a></td><td class=SDescription>Cria as guias com base na variável i3GEO.guias.CONFIGURA</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#ativa" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">ativa</a></td><td class=SDescription>Ativa uma determinada guia</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#ajustaGuiaFerramenta" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">ajustaGuiaFerramenta</a></td><td class=SDescription>Ajusta as guias de uma janela para que sempre fiquem no topo da janela, aplicando o overflow ao conteúdo das guias</td></tr><tr class="SSection"><td class=SEntry><a href="#guiaMovel" >guiaMovel</a></td><td class=SDescription>Controla as guias do tipo “movel”, que apresenta uma janela retrátil onde as opções são mostradas</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="#ABERTA" >ABERTA</a></td><td class=SDescription>Indica se a guia inicializará aberta</td></tr><tr class="SPropriedade SIndent2"><td class=SEntry><a href="#config" >config</a></td><td class=SDescription>Define os valores de posicionamento dos elementos que compõem a guia</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="#inicia" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">inicia</a></td><td class=SDescription>Inicializa a guia móvel</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#abreFecha" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">abreFecha</a></td><td class=SDescription>Abre ou fecha a guia móvel</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Variaveis"></a>Variaveis</h3></div></div>
<div class="CVariavel"><div class=CTopic><h3 class=CTitle><a name="ATUAL"></a>ATUAL</h3><div class=CBody><p>Guia que está ativa ou que será ativada ao iniciar o mapa</p><p>O nome da guia é a definida na variável i3GEO.guias.CONFIGURA</p><h4 class=CHeading>Tipo</h4><p>{string}</p><h4 class=CHeading>Default</h4><p>temas</p></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="ALTURACORPOGUIAS"></a>ALTURACORPOGUIAS</h3><div class=CBody><p>Altura em pixels que será aplicado em cada guia</p><p>Por default, a altura é calculada automaticamente, mas em alguns casos, pode ser necessário especificar o valor para permitir um melhor ajuste do layout do mapa</p><p>Mantenha como 0 para que o cálculo seja automático</p><h4 class=CHeading>Tipo</h4><p>{numeric}</p><h4 class=CHeading>Default</h4><p>0</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="CONFIGURA"></a>CONFIGURA</h3><div class=CBody><p>Define os parâmetros de cada guia que será mostrada no mapa, como título, conteúdo, etc.</p><p>Você pode modificar o nome de uma guia como no exemplo</p><p>i3GEO.guias.CONFIGURA.legenda.titulo = “nome diferente”;</p><p>Por padrão são definidas as guias legenda, temas, adiciona e mapas (links)</p><h4 class=CHeading>Exemplo</h4><blockquote><pre class="prettyprint">i3GEO.guias.CONFIGURA.legenda = { icone : "imagens/gisicons/show-legend.png", titulo : "Legenda", id : "guia4", idconteudo :
"guia4obj", click : function() { i3GEO.guias.mostra("legenda"); i3GEO.mapa.legendaHTML.cria("guia4obj"); } };</pre></blockquote><h4 class=CHeading>Tipo</h4><p>{objeto}</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="ORDEM"></a>ORDEM</h3><div class=CBody><p>Ordem de inclusão das guias no mapa. Essa opção é mais útil no caso do tipo sanfona, pois nesse caso, a primeira guia é sempre a que fica ativa. Se esse parametro for uma string vazia, a ordem utilizada será a ordem existente em i3GEO.guias.CONFIGURA.</p><p>Ao ser definida, apenas as guias indicadas no array serão incluídas</p><h4 class=CHeading>Exemplo</h4><p>i3GEO.guias.ORDEM = [“temas”,”adiciona”,”legenda”];</p><h4 class=CHeading>Tipo</h4><p>{array}</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="TIPO"></a>TIPO</h3><div class=CBody><p>Tipo de guia</p><p>Quando TIPO = “movel”, a inicialização da guia é feita em i3GEO.inicia Isso é ne cessário pq a guia móvel só pode ser criada após o posicionamento do corpo do mapa</p><h4 class=CHeading>Tipo</h4><p>{string}</p><h4 class=CHeading>Default</h4><p>guia</p><h4 class=CHeading>Values</h4><p>guia|sanfona|tablet|movel</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="idguias"></a>idguias</h3><div class=CBody><p>ID do elemento DOM, criado pelo YUI, onde serão inseridas as guias</p><h4 class=CHeading>Tipo</h4><p>{String}</p><h4 class=CHeading>Default</h4><p>guiasYUI</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="cria"></a>cria</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>cria : function(</td><td class="PParameter prettyprint " nowrap>onde</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Cria as guias com base na variável i3GEO.guias.CONFIGURA</p><p>As guias podem ser definidas no HTML do mapa, sem necessariamente estarem na variável configura.<b> As guias, nesse caso, devem ter como ID “guia’n’”, por exemplo id=”guia6”. Para cada uma dessas guias deve haver um DIV com o conteúdo. Esse DIV deve ter como ID “guia’n’obj”, por exemplo id=”guia6obj”. No caso de ser utilizado a guia móvel, com i3GEO.guias.TIPO = “movel” , “guia’n” não é necessário, uma vez que são utilizados os ícones definidos em i3GEO.guias.CONFIGURA</p><h4 class=CHeading>Parametro</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>{String}</td><td class=CDLDescription>id do elemento que conterá as guias</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ativa"></a>ativa</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>ativa : function(</td><td class="PParameter prettyprint " nowrap>guia</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Ativa uma determinada guia</p><h4 class=CHeading>Parametro</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>{String}</td><td class=CDLDescription>guia que será ativada</td></tr></table></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="ajustaGuiaFerramenta"></a>ajustaGuiaFerramenta</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>ajustaGuiaFerramenta : function(</td><td class="PParameter prettyprint " nowrap>idjanela,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>namespace</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Ajusta as guias de uma janela para que sempre fiquem no topo da janela, aplicando o overflow ao conteúdo das guias</p><p>Deve ser utilizado pelas ferramentas após a janela ter seu conteúdo renderizado.</p><p>Veja como exemplo a ferramenta tabela</p><h4 class=CHeading>Paremeters</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>{string}</td><td class=CDLDescription>id da janela</td></tr><tr><td class=CDLEntry>{string}</td><td class=CDLDescription>namespace da janela utilizado para definir os elementos DIV onde o conteúdo é renderizado</td></tr></table></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="guiaMovel"></a>guiaMovel</h2><div class=CBody><p>Controla as guias do tipo “movel”, que apresenta uma janela retrátil onde as opções são mostradas</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="SGroup"><td class=SEntry><a href="#Propriedades" >Propriedades</a></td><td class=SDescription></td></tr><tr class="SPropriedade SIndent1 SMarked"><td class=SEntry><a href="#ABERTA" >ABERTA</a></td><td class=SDescription>Indica se a guia inicializará aberta</td></tr><tr class="SPropriedade SIndent1"><td class=SEntry><a href="#config" >config</a></td><td class=SDescription>Define os valores de posicionamento dos elementos que compõem a guia</td></tr><tr class="SGroup"><td class=SEntry><a href="#Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#inicia" id=link6 onMouseOver="ShowTip(event, 'tt4', 'link6')" onMouseOut="HideTip('tt4')">inicia</a></td><td class=SDescription>Inicializa a guia móvel</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#abreFecha" id=link7 onMouseOver="ShowTip(event, 'tt5', 'link7')" onMouseOut="HideTip('tt5')">abreFecha</a></td><td class=SDescription>Abre ou fecha a guia móvel</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="ABERTA"></a>ABERTA</h3><div class=CBody><p>Indica se a guia inicializará aberta</p><h4 class=CHeading>Type</h4><p>{boolean}</p><h4 class=CHeading>Default</h4><p>false</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="config"></a>config</h3><div class=CBody><p>Define os valores de posicionamento dos elementos que compõem a guia</p><h4 class=CHeading>Default</h4><p>(start code) i3GEO.guias.guiaMovel.config = { larguraPuxador : 50, alturaPuxador : 319, alturaGuiaMovel : 0, larguraGuiaMovel : 320, topGuiaMovel : 0, guias : { icones : [], ids : [], idsconteudos : [], titulos : [], chaves : [] }, posicao : [ “c”, “r” ] }; (end)</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="inicia"></a>inicia</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">inicia : function()</td></tr></table></blockquote><p>Inicializa a guia móvel</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="abreFecha"></a>abreFecha</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>abreFecha : function(</td><td class="PParameter prettyprint " nowrap>forca</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Abre ou fecha a guia móvel</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>cria : function(</td><td class="PParameter prettyprint " nowrap>onde</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Cria as guias com base na variável i3GEO.guias.CONFIGURA</div></div><div class=CToolTip id="tt2"><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>ativa : function(</td><td class="PParameter prettyprint " nowrap>guia</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Ativa uma determinada guia</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>ajustaGuiaFerramenta : function(</td><td class="PParameter prettyprint " nowrap>idjanela,</td></tr><tr><td></td><td class="PParameter prettyprint " nowrap>namespace</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Ajusta as guias de uma janela para que sempre fiquem no topo da janela, aplicando o overflow ao conteúdo das guias</div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">inicia : function()</td></tr></table></blockquote>Inicializa a guia móvel</div></div><div class=CToolTip id="tt5"><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>abreFecha : function(</td><td class="PParameter prettyprint " nowrap>forca</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Abre ou fecha a guia móvel</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>