Funcoes (AtKit)

Documentação da API

AtKit.getVersion()

Parâmetros: nenhum Retorna: string

Obtém a versão do Atkit (format: x.y.zzzz)

AtKit.setName( name )

Parâmetros: name (string) Retorna: void

Configura o nome da barra de ferramentas

AtKit.setAbout( html )

Parâmetros: html (string) Retorna: void

Define o texto que irá aparecer na caixa de diálogo sobre a barra de ferramentas

AtKit.setLogo( src )

Parâmetros: src (string) Retorna: void

Define o logotipo para o parâmetro src

AtKit.isRendered( )

Parâmetros: none Retorna: bool

Retorna um valor boleano indicando se a barra de ferramentas foi renderizada

AtKit.getResourceURL( )

Parâmetros: none Retorna: string

Retorna a URL para os recursos da Atkit

AtKit.getPluginURL()

Parâmetros: none Retorna: string

Retorna a URL para o servidor de plugins

AtKit.setCSS( identifier, inlineStyle )

Parâmetros: identifier (string jQuery selector), inlineStyle (string) Retorna: void

Define uma regra CSS que será aplicada ao identificador usando um identificador jQuery

AtKit.setLanguage( language )

Parâmetros: language (string) Retorna: void

Define o idioma a ser usado pela Atkit

AtKit.getLanguage()

Parâmetros: none Retorna: string

Retorna o idioma no qual a Atkit está rodando

AtKit.addLocalisation( countrycode, key, value )

Parâmetros: Country code (string), Key (string), Value (string) Retorna: void

Adicionar uma localização para o código do país para o conjunto de chaves para o avaliador

AtKit.addLocalisationMap( countrycode, Object map )

Parâmetros: Country code (string), map (Object) Retorna: void

Adiciona um par de valor-chave conjunto de localizações

AtKit.localisation( key )

Parâmetros: key (string) Retorna: string

Obter a string de localização da chave

AtKit.addFix( regex, function )

Parâmetros: regex (Regular expression), function (function) Retorna: void

Adiciona o código a ser executado para um site específico. Regex é comparado com localização do site, se ele corresponder a função será executada. Pode ser usado para um limpeza local de sites HTML.

AtKit.addScript( url[, callback] )

Parâmetros: url (string), callback (function, optional) Retorna: void

Adicione um arquivo JavaScript para a página. Se a inserção for bem sucedida ela roda o callback

AtKit.addStylesheet( url, id )

Parâmetros: url (string), id (string) Retorna: void

Adicionar um arquivo CSS para a página. Nota: Pode ser sobrescrito por estilos na página. Usando . setCSS () é mais confiável.

AtKit.addFn( identifier, fn )

Parâmetros: identifier (string, unique), fn (function) Retorna: void

Adicionar uma função global que pode ser executado por qualquer parte da barra de ferramentas ou de seus plugins.

AtKit.addCloseFn( identifier, fn )

Parâmetros: identifier (string, unique), fn (function) Retorna: void

Adicionar uma função que será chamada quando a barra de ferramentas é encerrada.

AtKit.addResetFn( identifier, fn )

Parâmetros: identifier (string, unique), fn (function) Retorna: void

Adicionar uma função que será chamada quando a barra de ferramentas é resetada.

AtKit.addDialog( identifier, title, body )

Parâmetros: identifier (string, unique), title (string), body (string) Retorna: void

Adicionar uma caixa de diálogo que pode ser chamado com AtKit.show ()

AtKit.addButton( identifier, tooltip, icon, action[, dialogs[, functions[, options]]] )

Parâmetros: identifier (string, unique), tooltip (string), icon (string url), action (function), dialogs (Object), functions (Object), options (Object) Retorna: void

Adiciona um botão à barra de ferramentas

AtKit.removeButton( identifier )

Parâmetros: identifier (string) Retorna: void

Remove um botão na barra de ferramentas com o identificador especificado

AtKit.addSpacer( width )

Parâmetros: width (int) Retorna: void

Adiciona um botão espaçador. Se a largura for especificada ele irá adicionar o espaçador (mesmo tamanho de um botão), o número de vezes especificado pela largura (variável width).

AtKit.addSeparator( ident )

Parâmetros: ident (string) Retorna: void

Adiciona um elemento separador com classe opcional de ident após o último botão inserido. Se ident não for especificado, um número aleatório é escolhido.

AtKit.removeSeparator( ident )

Parâmetros: ident (string) Retorna: void

Remove todos os elementos de separação com classe de ident

AtKit.importPlugins( Array pluginArray[, callback] )

Parâmetros: pluginArray (Array), callback (callable) Retorna: void

Adiciona um array de plugins para AtKit

AtKit.addPlugin( identifier )

Parâmetros: identifier (string) Retorna: void

Adicionar um plugin especificado pelo identificador para a barra de ferramentas

AtKit.registerPlugin( identifier, plugin )

Parâmetros: identifier (string), plugin (callable) Retorna: void

Chamado por plugins para registrarem-se com o AtKit.

AtKit.getPluginMetadata( identifier )

Parâmetros: identifier (string) Retorna: plugin metadata (array)

Obtém os metadados associados com um plugin específico

AtKit.listPlugins()

Parâmetros: none Retorna: array

Retorna um array de plugins carregados

AtKit.show( dialog[, callback] )

Parâmetros: dialog (Object), callback (function) Retorna: void

Mostra um objeto de diálogo

AtKit.message( data[, callback] )

Parâmetros: dialog (string), callback (function) Retorna: void

Mostra uma caixa de diálogo com os dados especificados

AtKit.hideDialog()

Parâmetros: none Retorna: void

Esconde uma mensagem ou mostra uma caixa de diálogo

AtKit.call( identifier[, args] )

Parâmetros: identifier (string), args (multiple) Retorna: result of function

Chama a função especificada em AtKit.addFn()

AtKit.set( key, value )

Parâmetros: key (string), value (multiple) Retorna: void

Define armazenamento temporário. É removido ao atualizar a página.

AtKit.get( key )

Parâmetros: key (string) Retorna: multiple

Obtém o valor definido pelo AtKit.set()

AtKit.storageAvailable( )

Parâmetros: none Retorna: boolean

Retorna se o navegador atual suporta AtKit.storage () (armazenamento HTML5)

AtKit.storage( key[, value] )

Parâmetros: key (string, unique), value (string) Retorna: bool if value present, otherwise value (multiple)

Obtém / Define o armazenamento persistente para página atual. Usa HTML5 localStorage.

AtKit.clearStorage( )

Parâmetros: none Retorna: void

Limpa todos os objetos HTML5 LocalStorage definidos pela AtKit.storage ()

AtKit.lib( )

Parâmetros: none Retorna: jQuery

Retorna a biblioteca jQuery usada pelo Atkit

AtKit.render( )

Parâmetros: none Retorna: void

Renderiza a barra de ferramentas, uma vez que ela foi criada

AtKit.setDebugger( fn )

Parâmetros: fn (callable) Retorna: void

Define um callback a ser executado quando um evento de debug é acionado.

AtKit.close( )

Parâmetros: none Retorna: void

Fecha a barra de ferramentas.

AtKit.reset( )

Parâmetros: none Retorna: void

Reseta a barra de ferramentas.

AtKit.help( )

Parâmetros: none Retorna: void

Abre a página de ajuda para o idioma atual.