Criando e Registrando Metadados de Dashlet

O registro do dashlet contém a lista de todas as definições de dashlet em um aplicativo. Você deve registrar a definição de metadados de dashlet com o registro de dashlet antes de incluir o dashlet no painel. Usando o registro de dashlet, é possível primeiro registrar seus dashlets customizados e, em seguida, incluir esses dashlets em um painel.

A definição de metadados de dashlet baseia-se em XML.

Para criar metadados de dashlets, especifique o XML de definição de metadados de dashlet.
Para registrar os metadados do dashlet, chame o método registerDashlet( ) da classe SCUIDashboardManager (que é descrita no recurso Javadoc).

Amostra de XML: Definição de Metadados de Dashlet


<Dashlets>
			<Dashlet id="dashlet_one" title="Dashlet One" type="html" tag="tag_1">
						<Url>/stk/dashboard/dashlet_one.jsp</Url>
						<Imgurl>/stk/img/dashboard/dashlet_one_preview.png</Imgurl>
						<Description>
									Dashlet one description bundle key
						</Description>
						<Config numberOfColumns="3">
						</Config>
			</Dashlet>
			<Dashlet id="dashlet_two" title="Dashlet Two" type="extscreen" tag="tag_2"
												refreshable="Y">
						<Url>/stk/dashboard/dashlet_two.jsp</Url>
						<Imgurl>/stk/img/dashboard/dashlet_two_preview.png</Imgurl>
						<Description>
									Dashlet two description bundle key
						</Description>
						<Config numberOfColumns="2">
						</Config>
						<!-- Other metadata relevant to the dashlet can be added based on type
						and url ofthe dashlet -->
						<Group>
									<Section id="Airports" title="Airports" Icon="/stk/img/cog.png">
												<Link linkId="manage_airport" name="Manage Airports"
																		url="/stk/airport.do" />
									</Section>
									<Section id="Flights" title="Flight" icon="/stk/img/phone-icon.jpg">
												<Link linkid="manage_airport" name="Flights" url="/stk/flight.do" />
												<Link linkid="manage_airport" name="Flight Services"
																		url="/stk/flightService.do"/>
									</Section>
						</Group>
			</Dashlet>
			<Dashlet id="dashlet_three" title="Dashlet Three" type="html" tag="tag_3">
						<Url>/stk/dashboard/dashlet_three.jsp</Url>
						<Imgurl>/stk/img/dashboard/dashlet_three_preview.png</Imgurl>
						<Description>
									Dashlet three description bundle key
						</Description>
						<Config>
						</Config>
			</Dashlet>
</Dashlets>

As descrições dos atributos e elementos da amostra acima são fornecidas a seguir.

ID

Um identificador exclusivo do dashlet. Esse id é usado para consultar um dashlet e suas propriedades. Ele é usado por uma definição de painel para incluir um dashlet nele.

título

O título do dashlet. Pode ser uma chave de pacote configurável que pode ser localizada.

tipo

O tipo de dashlet é um metadados sobre o tipo de conteúdo retornado por uma URL de dashlet. Por padrão, o Web UI Framework suporta os tipos de dashlet a seguir:

HTML. A resposta do tipo HTML deve ser um fragmento de documento HTML válido. Os exemplos a seguir ilustram as várias maneiras pelas quais ela pode ser usada para renderizar a UI do dashlet: (1) Um fragmento HTML totalmente renderizado que pode ser visualizado em um navegador sem nenhum processamento adicional. (2) Um iframe que pode ser usado para integrar com segurança um widget a partir de websites externos. (3) um scriptlet que pode renderizar dinamicamente o conteúdo no contêiner.
extscreen. Um extscreen é um script de renderização de IU JavaScript ExtJS-based. Ele pode ser usado para renderizar componentes de UI dinâmicos e interativos.

identificação

Um valor separado por vírgula de nomes de tag do dashlet.

refreshable

Configure esse valor para Y para tornar o painel atualizável e exibir um ícone de atualização na caixa de ferramentas do dashlet. Quando o ícone de atualização é clicado, o dashlet individual é atualizado.

URL

A URL usada para obter o conteúdo para renderizar um dashlet. Para renderizar um dashlet no painel, uma solicitação precisará ser feita no servidor. A solicitação é feita nessa URL e a resposta é renderizada na UI.

Imgurl

A URL para a imagem a ser exibida mostrando uma visualização do conteúdo exibido pelo dashlet.

descrição

A descrição do dashlet. Pode ser uma chave de pacote configurável que pode ser localizada.

Configuração

O elemento Config é usado para definir as opções de configuração usadas para renderizar o dashlet na UI. Alguns dashlets que não requerem uma opção de configuração podem escolher não especificar o elemento Config. Nota: Além do elemento Config, um dashlet pode ter outros elementos de metadados. Em geral, o Config é usado para definir propriedades de UI, mas pode ser usado para reter qualquer tipo de metadados.