Aplicativo de vendas � Parte I

Natal DevMedia: Assine hoje e ganhe 3 meses gr�tis

Aplicativo de vendas � Parte I

Este artigo � o primeiro de uma s�rie onde iremos construir um pequeno aplicativo de vendas utilizando a plataforma eclipse. Ao longo desta s�rie de artigos, v�rios conceitos ser�o apresentados e exemplificados, desde a arquitetura em 3 camadas at� a cria��o e exibi��o de relat�rios para o usu�rio.

A arquitetura em plugins

Nos artigos anteriores, mostramos como funciona a arquitetura de plugins do eclipse e como criar seu pr�prio aplicativo RCP, que na verdade tamb�m � um plugin.

Em um aplicativo de maior escala, como o que estamos iniciando agora, n�o � vi�vel, em termos de legibilidade e manuten��o posterior do c�digo, que fa�amos um �nico e gigantesco plugin, contendo todo o c�digo de nossa aplica��o.

Iremos dividir o nosso programa em pequenos plugins que ser�o interdependentes, cada qual provendo uma funcionalidade espec�fica da aplica��o, como acesso a dados ou ajuda, por exemplo.

Uma grande vantagem de se utilizar esta metodologia � que o nosso programa estar� dividido em pequenas partes que poder�o ser atualizadas individualmente mais tarde, quando o aplicativo j� estiver em produ��o. Isso diminuir� consideravelmente o tamanho e o tempo dos downloads para o usu�rio do seu programa, bem como diminuir� tamb�m o uso de banda em seu servidor de atualiza��es.

Em quais partes dividir

Agora que j� sabemos da utilidade de dividirmos o nosso programa em partes menores a quest�o inevit�vel passa a ser: �como dividir o meu programa ?�.

N�o existe uma solu��o que atenda a todos, pois cada aplica��o desenvolvida ter� um ambiente pr�prio e cada programador v� as coisas do seu modo. Diante destes fatos, resta apenas sugerir um modo de dividir seu aplicativo RCP e deixar que os requisitos do seu projeto em particular determinem como far� isso posteriormente.

Para o aplicativo de vendas que estamos construindo, iremos dividi-lo em 5 partes, a saber:

�� Plugin principal (Aplicativo RCP propriamente dito)

�� Plugin de acesso a dados (Classes de comunica��o com o BD, etc.)

�� Plugin de ajuda (Fornece �ajuda� para os usu�rios do programa)

�� Plugin de impress�o (Relat�rios e classes relativas � impress�o)

�� Plugin de suporte (Classes �teis a todo o sistema)

O modelo ideal

O assistente de novo plugin do eclipse nos fornece uma pequena lista de modelos nos quais podemos basear a gera��o de c�digo para o novo plugin. Nos artigos �Introdu��o ao Eclipse RCP� e �Entendendo a Eclipse Workbench� eu mostrei este assistente e dois dos modelos dispon�veis foram utilizados para exemplificar o processo de cria��o de plugins.

Agora, que vamos come�ar um projeto �real�, qual o modelo correto a adotar ? Qual trar� um esqueleto de c�digo mais �completo�, que facilitar� a constru��o do restante da aplica��o posteriormente ?

A resposta �: depende.

Ca�mos aqui no mesmo problema da divis�o do aplicativo: cada programa � uma realidade diferente e cada programador pensa de maneira diferente. Para alguns, o �certo� � fazer tudo �no bra�o�, sem gera��o alguma de c�digo por parte da IDE. Para outros, quanto mais c�digo a IDE puder fornecer, tanto melhor.

Falando em termos de �acabamento�, com certeza o modelo de Correio (RCP Mail) � o mais completo, pois fornece, entre outras coisas: uma barra de ferramentas, uma barra de menus, duas views e algumas actions j� criadas. Estudar este modelo, como proposto no artigo �Entendendo a Eclipse Workbench� certamente lhe auxiliar� a entender melhor como funciona um aplicativo RCP.

Para o nosso aplicativo de vendas, iremos utilizar o modelo �Hello RCP�, o mais b�sico de todos, quase sem gera��o de c�digo por parte da IDE. E isto tem um motivo bem simples: ao escrevermos nossos pr�prios c�digos para a cria��o da barra de ferramentas, barra de menus, Views e Editors que iremos utilizar, o aprendizado ser� maior, pois n�o existe meio melhor de se aprender a programar do que programando.

O plugin principal

Agora que j� definimos algumas coisas sobre a nossa nova aplica��o, e j� decidimos utilizar o modelo �Hello RCP�, vamos criar o nosso plugin principal, que fornecer� a interface com o usu�rio do nosso programa.

N�o explicarei aqui os passos necess�rios � cria��o deste plugin, uma vez que eles j� foram abordados, com exemplos e capturas de tela, no artigo �Introdu��o ao Eclipse RCP�.

Com rela��o ao procedimento mostrado no artigo citado acima, apenas uma modifica��o: o nome do projeto deixa de ser br.com.devmedia.HelloWorld para ser br.com.devmedia.Commerce. Desnecess�rio dizer que �Commerce� ser� o nome do nosso programa.

Definindo o layout do nosso programa

Ap�s ter conclu�do a gera��o do plugin baseado no modelo Hello RCP voc� estar� com um programa b�sico, com apenas uma p�gina, em uma janela de 400x300 pixels.

Vamos alterar o layout deste programa, de forma a separar 3 �reas na interface principal. Uma barra lateral com duas divis�es, uma �rea na parte inferior para as views do programa e a EditorArea que ocupar� a maior parte da tela. Tamb�m iremos modificar a estrutura da workbench, aumentando o tamanho da janela e ativando a exibi��o da barra de status, da barra de ferramentas, da barra de visualiza��es r�pidas (mais sobre ela posteriormente) e definindo que o nosso programa deve salvar as altera��es feitas pelo usu�rio no layout da tela, sempre que o programa for encerrado.

Ap�s estas altera��es, a interface do programa dever� ser id�ntica � mostrada na Figura 01 abaixo:

Figura 01: Layout do programa de vendas

Se voc� leu o artigo anterior sobre a Eclipse Workbench, certamente saber� que para alterarmos a apar�ncia de nosso programa e a disposi��o das partes na tela, tivemos de modificar a nossa perspectiva.

No modelo Hello RCP utilizado, o arquivo Perspective.java � gerado automaticamente, mas o m�todo createInitialLayout que � o respons�vel pelo �desenho� da tela vem em branco, sem nenhum conte�do.

Assim, para modificarmos a nossa perspectiva, de forma que fique como a mostrada na figura 01, � necess�rio adicionarmos conte�do ao m�todo createInitialLayout, de maneira que a classe Perspective fique como mostrado na listagem 01:

package br.com.devmedia.commerce;

import org.eclipse.ui.IFolderLayout;

import org.eclipse.ui.IPageLayout;

import org.eclipse.ui.IPerspectiveFactory;

public class Perspective implements IPerspectiveFactory {

�� public void createInitialLayout(IPageLayout layout) {

�� String editorArea = layout.getEditorArea();

�� layout.setEditorAreaVisible(true);

�� IFolderLayout top_left_folder = layout.createFolder("lateral_superior",

�� IPageLayout.LEFT, 0.25f, editorArea);

�� IFolderLayout bot_left_folder = layout.createFolder("lateral_inferior",

�� IPageLayout.BOTTOM, 0.70f, "lateral_superior");

�� IFolderLayout bot_folder = layout.createFolder("cadastro",

�� IPageLayout.BOTTOM, 0.70f, editorArea);

�� }

}

Listagem 01: Perspective.java

Note que para criarmos as diversas �reas no nosso programa utilizamos �Folders�, ou melhor, da interface IFolderLayout e do m�todo createFolder.

N�o cabe agora explicar como funciona o mecanismo de �folders� da plataforma eclipse, mas a parte pr�tica � bem simples.

O m�todo createFolder recebe 5 par�metros, nesta ordem:

�� folderId: O �nome� da folder que voc� est� criando

�� relationship: uma constante definida em IPageLayout que especifica a localiza��o da folder a ser criada. Os valores poss�veis s�o TOP, BOTTOM, LEFT e RIGHT.

�� ratio: Um valor float que define o tamanho da folder que se est� criando.

�� refId: A id da �rea onde se est� inserindo a nova folder. Pode ser uma folder criada anteriormente (como a �lateral_superior� mostrada na listagem 01) ou o id especial retornado pelo m�todo getEditorArea().

Voc� pode ir subdividindo a tela, criando folders uma dentro da outra, � vontade. As folders podem conter Views, mas n�o Editors. Estes podem aparecer apenas na �rea especial, ou EditorArea como dito anteriormente.

Caso voc� n�o possua Editors em seu programa, pode simplesmente �esconder� a EditorArea, de forma a aproveitar todo o espa�o da tela com suas folders. Para esconder a EditorArea, basta defini-la como �n�o vis�vel�, atrav�s do m�todo

setEditorAreaVisible, mostrado na listagem 01. Note que definimos explicitamente esta �rea como vis�vel, pois teremos editors em nosso programa.

A pr�xima etapa do procedimento de modifica��o da apar�ncia de nosso aplicativo � a classe ApplicationWorkbenchWindowAdvisor. Nela, h� um m�todo denominado preWindowOpen que determina v�rios aspectos relacionados � janela principal de nosso programa.

Posteriormente em nossa s�rie de artigos, iremos nos aprofundar nesta classe, que fornece meios de executarmos c�digos pr�prios do dom�nio de nossa aplica��o durante a inicializa��o do programa.

Por hora, vamos nos ater aos m�todos setShow* da classe IWorkbenchWindowConfigurer que permite mostrar/esconder v�rios elementos visuais da plataforma RCP. Para ativar a exibi��o de menus, barra de ferramentas, barra de visualiza��es r�pidas, barra de progresso de opera��es em background e a barra de status do nosso programa, modifique o m�todo preWindowOpen de maneira a deix�-lo como mostrado na listagem 02:

public void preWindowOpen() {

�� IWorkbenchWindowConfigurer configurer = getWindowConfigurer();

�� configurer.setInitialSize(new Point(800, 600));

�� configurer.setShowCoolBar(true);

�� configurer.setShowStatusLine(true);

�� configurer.setShowFastViewBars(true);

�� configurer.setShowProgressIndicator(true);

�� configurer.setShowMenuBar(true);

�� configurer.setTitle("DevMedia Commerce vers�o alpha 0.1");

�� }

Listagem 02: M�todo preWindowOpen

O �ltimo passo necess�rio agora � a modifica��o da classe ApplicationWorkbenchAdvisor, adicionando-lhe o m�todo initialize, que usaremos para configurar um aspecto importante de nosso programa.

Atrav�s deste m�todo, e da classe IWorkbenchConfigurer poderemos informar � plataforma eclipse que as modifica��es do usu�rio no layout da interface dever�o ser armazenadas em disco, de maneira que na pr�xima utiliza��o do programa o usu�rio encontrar� o ambiente como o deixou.

Modifique a classe adicionando o m�todo initialize mostrado na listagem 03:

public void initialize(IWorkbenchConfigurer configurer) {

�� super.initialize(configurer);

�� configurer.setSaveAndRestore(true);

�� }

Listagem 03: M�todo initialize

Executando agora o Commerce, ele dever� exibir uma tela id�ntica � da figura 01. Caso surja alguma mensagem de erro, revise os procedimentos apresentados e confira as modifica��es realizadas nas diversas classes do programa.

Barra de menus e barra de ferramentas

O Eclipse trabalha com o conceito de Actions para a cria��o de op��es nas barras de menu e de ferramentas. Uma Action � uma classe que extende org.eclipse.jface.actions.Action. Atrav�s desta classe � poss�vel definir o texto, o tooltip (texto de ajuda que aparece quando passamos o mouse sobre a op��o), o �cone, o atalho de teclado, entre outros aspectos.

Para esta vers�o inicial do Commerce, iremos definir apenas 3 actions:

�� Exibir cadastro de produtos

�� Exibir cadastro de clientes

�� Exibir listagem de vendas

Para isso iremos criar 3 classes, respectivamente: OpenViewProdutos, OpenViewClientes, OpenViewVendas.

As imagens utilizadas neste exemplo devem ser adicionadas ao projeto, dentro da pasta j� existente �icons�.

Para adicionar uma imagem � esta pasta, clique sobre ela com o bot�o direito do mouse e navegue pelo menu at� a op��o Nova -> Arquivo. Uma tela como a da figura 02 surgir�:

Figura 02: Adicionar �cone ao projeto

Apenas informe o nome da imagem que deseja adicionar e clique sobre o bot�o �Concluir�. Um novo arquivo em branco ser� criado em seu ambiente de trabalho.� Feche-o. Em seguida, utilizando o navegador de arquivos de seu sistema operacional localize a pasta do projeto e substitua o arquivo em branco gerado pelo Eclipse pelo arquivo correto contendo a imagem que deseja adicionar ao projeto. De volta ao Eclipse, clique com o bot�o direito do mouse sobre a pasta icons e escolha a op��o �Atualizar�.

Fa�a este procedimento 3 vezes, para adicionar as imagens referentes a clientes, produtos e vendas. Estas imagens devem ter 16x16 pixels de tamanho e preferencialmente devem estar em formato gif ou png.

Dica: Icones e imagens em formato e tamanho pr�prios para serem utilizados em aplica��es desktop como essa s�o denominados, em ingl�s, como stock icons. Uma infinidade de �cones e imagens assim est�o dispon�veis na internet, gratuitamente e sem qualquer restri��o de distribui��o junto ao seu programa. Uma busca por �stock icons� retorna muita coisa interessante.

Criando as actions

Iremos criar agora as 3 classes referentes �s actions de nosso programa. Clique sobre o pacote principal do projeto, br.com.devmedia.Commerce com o bot�o direito do mouse e escolha a op��o Nova -> Classe como ilustrado na figura 03:

Figura 03: Criando as classes de a��es

Surgir� uma tela do assistente de nova classe do Eclipse, como mostrado na figura 04:

Figura 04: Assistente de nova classe do Eclipse

Preencha o nome da classe com OpenViewClientes e o nome da Superclasse com org.eclipse.jface.actions.Action, conforme ilustrado pela figura 04.

Repita os procedimentos acima para as classes OpenViewProdutos e OpenViewVendas.

Como n�o implementamos ainda as Views de Clientes, Produtos ou Vendas, iremos adicionar �s nossas actions um c�digo que apenas exibe uma mensagem ao usu�rio informando que este recurso ainda n�o est� dispon�vel.

Para isso, vamos sobrecarregar o m�todo run() de nossas actions, e tamb�m deveremos implementar um construtor customizado. Ap�s essas modifica��es, a classe OpenViewClientes dever� estar como mostrado na listagem 04:

package br.com.devmedia.commerce;

import org.eclipse.jface.action.Action;

import org.eclipse.jface.dialogs.MessageDialog;

import org.eclipse.ui.IWorkbenchWindow;

public class OpenViewClientes extends Action

{

�� private IWorkbenchWindow window;

��

�� public OpenViewClientes (IWorkbenchWindow window, String label) {

�� this.window = window;

setId("Commerce.openViewClientes");

�� setActionDefinitionId("Commerce.openViewClientes");

�� setText(label);

�� setImageDescriptor(Activator.getImageDescriptor("icons/clientes.gif"));

�� }

��

�� public void run () {

�� MessageDialog.openInformation (window.getShell(), "Commerce",

�� "Este recurso ainda n�o est� implementado");

�� }

}

Listagem 04: Classe OpenViewClientes implementada

Modifique tamb�m as outras duas classes, OpenViewProdutos e OpenViewVendas modificando apenas o path para o �cone correspondente e o ID de comando.

Adicionando as actions criadas na toolbar e menubar

Agora que temos nossas actions criadas, vamos adicion�-las � barra de menus e � barra de ferramentas do nosso programa, de modo que fiquem dispon�veis para o usu�rio.

Quem controla este aspecto dos programas RCP � a classe ApplicationActionBarAdvisor tamb�m criada pelo Eclipse junto com o nosso plugin. Do mesmo modo que a classe Perspective, esta tamb�m est� �vazia�, apenas com a assinatura dos m�todos. Vamos adicionar agora o c�digo que ir� inserir nossas actions rec�m-criadas � interface do programa.

Modifique a classe citada de forma a ficar como mostrado na listagem 05:

package br.com.devmedia.commerce;

import org.eclipse.jface.action.ICoolBarManager;

import org.eclipse.jface.action.IMenuManager;

import org.eclipse.jface.action.IToolBarManager;

import org.eclipse.jface.action.MenuManager;

import org.eclipse.jface.action.ToolBarContributionItem;

import org.eclipse.jface.action.ToolBarManager;

import org.eclipse.swt.SWT;

import org.eclipse.ui.IWorkbenchWindow;

import org.eclipse.ui.application.ActionBarAdvisor;

import org.eclipse.ui.application.IActionBarConfigurer;

public class ApplicationActionBarAdvisor extends ActionBarAdvisor {

�� private OpenViewClientes openViewClientes;

�� private OpenViewProdutos openViewProdutos;

�� private OpenViewVendas openViewVendas;

��

�� public ApplicationActionBarAdvisor(IActionBarConfigurer configurer) {

�� super(configurer);

�� }

�� protected void makeActions(IWorkbenchWindow window) {

�� openViewClientes = new OpenViewClientes (window, "Cadastro de clientes");

�� register(openViewClientes);

��

�� openViewProdutos = new OpenViewProdutos (window, "Cadastro de produtos");

�� register(openViewProdutos);

��

�� openViewVendas = new OpenViewVendas (window, "Cadastro de vendas");

�� register(openViewVendas);

�� }

�� protected void fillMenuBar(IMenuManager menuBar) {

�� MenuManager princMenu = new MenuManager("&Commerce", "principal");

��

�� menuBar.add(princMenu);

�� princMenu.add(openViewClientes);

�� princMenu.add(openViewProdutos);

�� princMenu.add(openViewVendas);

�� }

��

�� protected void fillCoolBar(ICoolBarManager coolBar)�� {

�� IToolBarManager toolbar = new ToolBarManager(SWT.FLAT | SWT.RIGHT);

�� coolBar.add(new ToolBarContributionItem(toolbar, "main"));

�� toolbar.add (openViewClientes);

�� toolbar.add (openViewProdutos);

�� toolbar.add (openViewVendas);

�� }

}

Listagem 05: ApplicationActionBarAdvisor com as actions adicionadas

Ao executar agora o seu aplicativo, ver� que a barra de menus e a barra de ferramentas surgem, trazendo as actions que definimos. A figura 05 mostra como ficou o Commerce ap�s as modifica��es realizadas.

Figura 05: Barras de menu e de ferramentas

Neste artigo, criamos o plugin principal do que ser� o nosso programa de vendas �Commerce�. Vimos como funciona o sistema de actions da plataforma eclipse, ao criarmos nossas pr�prias actions e tamb�m definimos o layout de nossa tela principal.

No pr�ximo artigo da s�rie veremos como criar um plugin de acesso a dados, comunicando-se com um SGBD e tamb�m o plugin contendo as classes de suporte de nossa aplica��o.

At� a pr�xima.