Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice

Índice

...

maxLevel4
outlinetrue
exclude.*ndice
stylenone


Objetivo

O objetivo desse guia é apresentar as propriedades dos componentes que fazem parte da plataforma Fluig.


Arquivo application.info

Os componentes Componentes como layouts e widgets possuem um arquivo chamado application.info. Esse arquivo contém várias propriedades e informações importantes para o correto funcionamento dos componentes.

...

A seguir são apresentadas as propriedades que são comuns a todos os componentes e também as específicas de cada componente.


Propriedades comuns a todos os tipos de componentes

As propriedades apresentadas a seguir aparecem em todos os tipos de componentes.

PropriedadeDescrição

application.

type=<tipo> 

type 

O valor

"<tipo>"

define qual o tipo do componente: "widget", "layout" ou "theme".

application

.code=<código>Iidentificador.application.title=<título>Título.

.title

Título do seu componente. Utilizado para as telas em que é apresentado em uma lista - adição de widgets, por exemplo.

Esta informação também deve ser incluída nos arquivos de internacionalização (.properties) para que seja aplicada na widget.

application.code

Código único de identificação do componente. Geralmente é usado um nome que indica a função do componente.

Ex.: se o título de um widget for "Teste de Qualidade", seu código pode ser "testedequalidade", "testequalidade", "teste_qualidade" etc.

application.description

Uma breve explicação sobre a aplicação do componente. Considerando o exemplo do widget fictício "Teste de Qualidade", poderíamos fazer a seguinte descrição: "Utilitário integrado às rotinas de teste de qualidade do ERP".

O tamanho mínimo da descrição é 1 caractere e o tamanho máximo é de 255 caracteres

application.description=<descrição>Descrição

.

application.category

=<SYSTEM>

Categoria do componente. Propriedade utilizada para filtro em determinados

funções do sistema

recursos da plataforma, como por exemplo, a tela de seleção de widget quando se edita uma página.

application.renderer

=<id>

"<id>"

Indica o tipo de renderizador exigido

(atualmente

. Atualmente somente o

Freemarker

valor "freemarker" é suportado

)

.

application.icon

=<icon.png>

Ícone para representação visual. Caso não informado

o sistema

, a plataforma assumirá um ícone padrão para sua


representação visual.

developer.

code=<developer-code> 

code 

Código do desenvolvedor. Para uso interno da plataforma.

developer.name

=<TOTVS S.A.>

Nome do desenvolvedor. Para uso interno da plataforma.

developer.url

=<http://www.totvs.com

 

URL do desenvolvedor. Para uso interno da plataforma.

locale.file.base.name

=<prefixo>

Nome base do arquivo de tradução que será seguido pelo locale

(ex

. Ex.: prefixo_PT_BR e prefixo_EN_US

)

. Se não


informado,

será

é usado o código do layout. Entenda melhor aqui.

application.resource.css.1

=</resources/css/<arquivo>.css>

Opcional. Nome do arquivo CSS a ser carregado durante a renderização. Podem ser

informado

informados vários arquivos

, o

. O número no final do

dome

nome da propriedade indica a ordem de carga. Entenda melhor aqui.

application.resource.js.2

=</resources/js/<arquivo>.js>

Opcional. Nome do arquivo JS a ser carregado durante a renderização. Podem ser

informado

informados vários arquivos

, o

. O número no final do nome da propriedade indica a ordem de carga. Entenda melhor aqui.

    layout.file=<layout.ftl>(Apenas para layout) Nome do arquivo a ser renderizado. Se não informado, será assumido “layout.ftl”.
application.origincodeOpcional. Usado quando se está extendendo um componente, deve ser informado o código do componente de origem.
application.extensibleOpcional. Define se um componente pode ser extensível ou não, por padrão seu valor é false

Propriedades específicas para Widgets

A seguir são apresentadas as propriedades que são específicas dos componentes do tipo Widget.

edit.file=<edit.ftl>(Apenas para widget)

Propriedade

Descrição

edit.file

Nome do arquivo a ser renderizado na edição

da

do widget. Entenda melhor aqui.

view.file

=<view.ftl>

(Apenas para widget)

Nome do arquivo a ser renderizado na visualização

da

do widget. Entenda melhor aqui.

simple.deploy

=<true / false>

(

Apenas para widget)

true ou false)

Quando marcado como true, será feito deploy apenas dos conteúdos estáticos

da

do widget.

Propriedades Específicas para Widgets

PropriedadeDescrição
  

 

Propriedades Específicas para Layouts

Classes Java, por exemplo, serão ignoradas. Entenda melhor aqui.

Se marcado como false, será feito deploy também das classes Java e, caso o widget esteja dentro de um EAR, ele será extraído.

application.uiwidget

(true ou false)

 Propriedade específica para a listagem de widget na tela de edição de páginas. Entenda melhor aqui.


Propriedades específicas para Layouts

As propriedades específicas dos componentes do tipo Layout são descritas a seguir:

PropriedadeDescrição

layout.file

Nome do arquivo a ser renderizado. Se não for informado, é assumido como “layout.ftl”.

slot.SlotMenu

PropriedadeDescriçãoslot.SlotMenu=<menu>

Opcional. Entretanto, quando o arquivo .ftl possuir slot de

Menu

menu (SlotMenu), é necessário informar qual widget de menu deve ser

utilizada

utilizado. Nesse caso, "menu" deve ser informado

nesse caso

. Entenda melhor aqui.

slot.SlotLogin

=<sociallogin>

Opcional. Entretanto, quando o arquivo .ftl possuir slot de

Login

login (SlotLogin), é necessário informar qual

sidget

widget de login deve ser

usada

utilizado. Apesar de haver mais de

um

uma opção para menu, recomendamos a utilização do valor "sociallogin" nesse caso. Entenda melhor aqui.

application.uilayout

Opcional. Default true (true ou false)

 Propriedade específica para a listagem de layouts na tela de edição de páginas ou na tela de troca de layout.

application.responsiveLayout=true|false

Validação necessária para informar se o layout está escrito de forma responsivo.

Informações

A propriedade application.responsiveLayout=true|false estará disponível a partir da release 1.8.1 do TOTVS Fluig Plataforma.

application.newBuilder=true|false

Validação para o carregamento no novo construtor de páginas. Entenda melhor aqui.

Informações

A propriedade application.newBuilder=true|false estará disponível a partir da release 1.8.1 do TOTVS Fluig Plataforma.