Class: Label

@nginstack/web-framework/lib/label/Label~ Label


new Label(process)

Um objeto label é um componente para exibir textos na interface.
O label pode conter várias linhas de texto, não podendo ser editado.
O texto do label pode conter comandos HTML que serão renderizados pelo navegador no momento da exibição.

Parameters:
Name Type Description
process Process

Processo onde será exibido o texto do label.

Example
var label = this.label("myLabel", "<b>Atenção:</b><br>Siga as instruções
abaixo para completar o procedimento")
label.border = "1px"
label.width  = "100px"
label.height = "50px"
label.write()

Members


align :string

Alinhamento do texto no label. Por padrão, assume o valor Alignment.LEFT.
Pode receber um dos seguintes valores: Alignment.LEFT, Alignment.RIGHT, Alignment.CENTER ou Alignment.JUSTIFY.

Type:
  • string

autoSanitize :boolean

Determina se texto do rótulo deve ser tratado para remover tags que possam ser utilizadas com o objetivo de injetar scripts maliciosos em ataques do tipo Cross Site Scripting (XSS).

Ao desativar esta propriedade, é de crítica importância que algum tipo de validação ou sanitização seja realizada no conteúdo a ser escrito na tela.

Type:
  • boolean

backgroundColor :string

Define a cor de fundo do label. O valor a ser informado pode ser num dos seguintes formatos: "#FFFFFF" - hexadecimal, "blue" - cor por extenso (em inglês), "rgb(100, 150, 255)" - formato RGB. Alterações feitas nesta propriedade em tempo de execução serão refletidas na interface dinamicamente.

Type:
  • string

border :string

Largura das bordas do label. Por padrão, o label não exibe bordas.
O valor informado deve ser seguido da unidade, como "1px".

Type:
  • string

color :string

Define a cor do texto do label. O valor a ser informado pode ser num dos seguintes formatos: "#FFFFFF" - hexadecimal, "blue" - cor por extenso (em inglês), "rgb(100, 150, 255)" - formato RGB.

Type:
  • string

css :string

Classe de CSS que será atribuída ao label.

Type:
  • string

fontSize :string

Deve ser informado uma string com o valor seguido da unidade, como "8pt". Por padrão é utilizado o valor definido no tema do usuário.

Type:
  • string

height :string

Altura do label na tela. Deve ser informada uma string com a altura seguida da unidade, por exemplo: "150px".
Caso não seja informado, o label assumirá altura variável conforme o conteúdo.
Alterações feitas nesta propriedade em tempo de execução serão refletidas na interface dinamicamente.

Type:
  • string

name :string

Nome do label. É o identificador do objeto label. Deve ser único e é o nome que será passado para o método label() do process para se obter o objeto label desejado.

Type:
  • string

text :string

Texto a ser apresentado no label. É por esta propriedade que é possível indicar o que o objeto label irá exibir na tela. O texto atribuído pode conter tags de HTML.

Type:
  • string

visible :boolean

Indica a visibilidade do label na interface. Por padrão, o label quando escrito estará visível.

Type:
  • boolean

width :string

Largura do label na tela. Deve ser informada uma string com a largura seguida da unidade, por exemplo: "150px".
Caso não seja informado, o label assumirá uma largura variável conforme o conteúdo.
Alterações feitas nesta propriedade em tempo de execução serão refletidas na interface dinamicamente.

Type:
  • string

Methods


write()

Escreve o label na interface.