ReferênciaÍndice
- Tipos de propriedades/Modificadores
- Elementos de uso geral para serem utilizados em qualquer arquivo XML (
.xml,.rkh,.pluginmap) - Elementos a serem usados na descrição XML do plugin
- Propriedades dos elementos do plugin
- Plugins incorporáveis incluídos na versão oficial RKWard
- Elementos para uso em arquivos
.pluginmap - Elementos para uso em arquivos .rkh (ajuda)
- Funções disponíveis para scripts de lógica de GUI
Em alguns trechos desta introdução, mencionamos as “propriedades” de elementos da GUI ou outros. Na verdade, existem vários tipos diferentes de propriedades. Normalmente, você não precisa se preocupar com isso, pois pode usar o bom senso para conectar qualquer propriedade a qualquer outra. No entanto, internamente, existem diferentes tipos de propriedades. Isso é importante para a recuperação de valores especiais no modelo JS. Nas instruções getString("id")/getBoolean("id")/getList("id"), você também pode especificar alguns dos chamados “modificadores”, como este: getString("id.modificador"). Esse modificador afetará a forma como o valor é impresso. Continue lendo para ver a lista de propriedades e os modificadores que cada uma delas disponibiliza:
- Propriedades de string
O tipo de propriedade mais simples, usado simplesmente para armazenar um trecho de texto. Modificadores:
- Sem modificador ("")
A string conforme definida/configurada.
- quoted
A string em formato de aspas (adequada para ser passada para R como caractere).
- Propriedades boleanas
Propriedades que podem ser ativadas ou desativadas, verdadeiras ou falsas. Por exemplo, as propriedades criadas por tags <convert>, bem como a propriedade que acompanha uma <checkbox> (veja abaixo). Os seguintes valores serão retornados de acordo com o modificador fornecido:
- Sem modificador ("")
Por padrão, a propriedade retornará 1 se for verdadeira e 0 caso contrário. A maneira recomendada de obter valores booleanos é usando
getBoolean(). Observe que, paragetString(), a string "0" será retornada quando a propriedade for falsa. Essa string seria avaliada como verdadeira, e não como falsa, em JavaScript.- "labeled"
Retorna a string "true" quando verdadeiro, "false" quando falso, ou quaisquer strings personalizadas que tenham sido especificadas (normalmente em uma <checkbox>).
- "true"
Retorna a string como se a propriedade fosse verdadeira, mesmo que seja falsa.
- "false"
Retorna a string como se a propriedade fosse falsa, mesmo que seja verdadeira.
- "not"
Isso na verdade retorna outra propriedade booleana, que é o inverso da atual (isto é, falso se verdadeiro, verdadeiro se falso)
- "numeric"
Obsoleto, fornecido para compatibilidade com versões anteriores. Equivalente a nenhum modificador "". Retorna "1" se a propriedade for verdadeira ou "0" se for falsa.
- Propriedades de inteiro
Uma propriedade projetada para armazenar um valor inteiro (mas, é claro, ainda retorna uma string de caracteres numéricos para o modelo JS). Não aceita nenhum modificador. Usada em <spinbox>es (veja abaixo)
- Propriedades de número real
Uma propriedade projetada para armazenar um valor numérico real (mas, é claro, ainda retorna uma string de caracteres numéricos para o modelo JS). Usada em <spinbox>es (veja abaixo)
- Sem modificador ("")
Para
getValue() / getString(), isso retorna o mesmo que "formatted". Em versões futuras, será possível obter uma representação numérica.- "formatted"
Retorna o número formatado (como uma string).
- Propriedades RObject
Uma propriedade projetada para selecionar um ou mais objetos R. Usada principalmente em varselectors e varslots. Os seguintes valores serão retornados de acordo com o modificador fornecido:
- Sem modificador ("")
Por padrão, a propriedade retornará o nome completo do objeto selecionado. Se mais de um objeto for selecionado, os nomes dos objetos serão separados por quebras de linha ("\n").
- "shortname"
Semelhante ao anterior, mas retorna apenas o(s) nome(s) abreviado(s) do(s) objeto(s). Por exemplo: um objeto dentro de uma lista receberia apenas o nome que possui dentro da lista, sem o nome da lista.
- "label"
Semelhante ao anterior, mas retorna o(s) rótulo(s) do(s) objeto(s) RKWard (se nenhum rótulo estiver disponível, isso é o mesmo que nome curto)
- Propriedades de lista de strings
Esta propriedade contém uma lista de strings.
- Sem modificador ("")
Para
getValue()/getString(), isso retorna todas as strings separadas por "\n". Quaisquer caracteres "\n" em cada item são escapados como literalmente "\n". No entanto, o uso recomendado é buscar o valor comgetList(), que retornará uma matriz de strings.- "joined"
Retorna a lista como uma única string, com os itens unidos por "\n". Em contraste com a ausência de modificador (""), as strings individuais _não_ são escapadas.
- Propriedades de código
Uma propriedade mantida por plugins que geraram código. Isso é importante para incorporar plugins, a fim de incorporar o código gerado pelo plugin incorporado no código gerado pelo plugin incorporador (de nível superior). Os os seguintes valores serão retornados de acordo com o modificador fornecido:
- Sem modificador ("")
Retorna o código completo, ou seja, as seções "preprocess", "calculate", "printout" e (mas não "preview") concatenadas em uma única string.
- "preprocess"
Retorna apenas a seção de pré-processamento do código
- "calculate"
Retorna apenas a seção de cálculo do código
- "printout"
Retorna apenas a seção de impressão do código
- "preview"
Retorna a seção de pré-visualização do código