pt.moredata.fglreport
Interface FglReport

All Known Implementing Classes:
AbstractFglReport

public interface FglReport

FglReport.java Title: Biblioteca de classes para aplicações com BD

Description:

Construção de reports quase compativel com reports de informix 4gl Copyright:

     Copyright (C) 2002  Moredata

     This program is free software; you can redistribute it and/or
     modify it under the terms of the GNU General Public License
     as published by the Free Software Foundation; either version 2
     of the License, or (at your option) any later version.

     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.

     You should have received a copy of the GNU General Public License
     along with this program; if not, write to the Free Software
     Foundation, Inc, 59 Temple Place-Suite 330, Boston, MA 02111-1307, USA.
     

Created: Wed Jun 26 17:20:49 2002 Company: Moredata

Version:
: $Revision: 1.2 $ Revision $Revision: 1.2 $ $Date: 2003/05/13 18:06:46 $ $Author: aricardo $ $Log: FglReport.java,v $ Revision 1.2 2003/05/13 18:06:46 aricardo + documentação de todas a classes do fglreport Revision 1.1.1.1 2003/04/25 12:47:59 pcarmo Migracao do projecto 'src' deste repositorio apos a reorganizacao da estrutura de directorias do projecto.
Author:
Ricardo Amaro

Field Summary
static int SWING
           
static int TEXT
           
 
Method Summary
 void addFglReportListener(FglReportListener reportListener)
          Adiciona um listener dos eventos do report
 void addObject(java.lang.Object obj)
          Acrescenta o objecto nao grafico ao buffer de escrita do report
 void clearFglReportListener()
          Apaga todos os report Listeners
 void finishReport()
          Termina o report fechando o ficheiro se for caso disso ou apenas mudando as variáveis do objecto (se Stream)
 int getColNo()
          Método que devolve o número da coluna corrente
 int getFirstPageHeaderLen()
          Metodo que devolve o tamanho do Header da primeira pagina
 java.lang.Object getGroup()
          Método que devolve o grupo
 java.lang.Object getGroupValue()
          Método que devolve o valor do campo da nova chave
 int getLineNo()
          Método que devolve o número da linha corrente
 int getPageHeaderLen()
          Metodo que devolve o tamanho do Header das outras paginas
 int getPageLen()
          Metodo que devolve o numero de linhas das páginas do report
 int getPageNo()
          Método que devolve o número da página corrente
 int getPageTrailerLen()
          Metodo que devolve o tamanho do Trailer do report
 int getPageWidth()
          Metodo que devolve o numero de colunas do report
 void gotoColumn(int coluna)
          Posiciona-se na coluna dada como parâmetro
 void gotoLine(int linha)
          Posiciona-se na linha dada como parâmetro
 void newLine()
          Nova linha no reportPreocupa-se em tratar dos headers e trailers
 void newPage()
          Nova página
 void outputToReport()
          Executa o on every row do report
 void outputToReport(java.util.ArrayList reportParameters)
          Envia determinado output para o report.
 void print(java.lang.String str)
          Imprime a string enviada na coluna passada como parâmetro e na linha corrente
 void print(java.lang.String str, int tFont)
          Imprime a string enviada na coluna passada como parâmetro e na linha corrente, mudando-lhe o tamanho da font
 void printBold(java.lang.String str)
          Imprime a string enviada na coluna passada como parâmetro e na linha corrente, afectando a sua fonte para Bold
 void printBold(java.lang.String str, int tFont)
          Imprime a string enviada na coluna passada como parâmetro e na linha corrente, afectando a sua fonte para Bold e muda a tamanho desta mesma
 void printBox(int num_colunas, int num_linhas)
          Imprime uma box na linha e coluna corrente
 void println(java.lang.String str)
          Imprime a string enviada na coluna passada como parâmetro na linha corrente e muda de linha
 void removeFglReportListener(FglReportListener reportListener)
          Remove um listener para os eventos do report
 void setFirstPageHeaderLength(int tam)
          Define o tamanho do FirstPageHeader
 void setLineno(int linha)
          Reposiciona-se na linha dada como argumento.
 void setNomeFont(java.lang.String nFont)
          Define o nome da font nas impressões (Courier, Times New Roman, Arial etc)
 void setPageHeaderLength(int tam)
          Define o tamanho do PageHeader
 void setPageLen(int tam)
          Define o tamanho da Página
 void setPageTrailerLength(int tam)
          Define o tamanho do PageTrailer
 void setPageWidth(int tam)
          Metodo que define o numero de colunas de um report
 void setTamanhoFont(int tFont)
          Define o tamanho da font nas impressões
 void startReport()
          Inicia um report sem qualquer ficheiro associado
 void writeReport(java.lang.String dirName, java.lang.String fileName)
          Escreve o report produzido ate essa altura
 

Field Detail

SWING

public static final int SWING
See Also:
Constant Field Values

TEXT

public static final int TEXT
See Also:
Constant Field Values
Method Detail

startReport

public void startReport()
Inicia um report sem qualquer ficheiro associado


outputToReport

public void outputToReport()
Executa o on every row do report


outputToReport

public void outputToReport(java.util.ArrayList reportParameters)
Envia determinado output para o report.

Recebe um ArrayList como parâmetro para simular a recepção de parâmetros dos reports de Informix 4gl que permitem ordenações e funções agregadas em after group

Parameters:
reportParameters - ArrayList que simula a recepção de parâmetros dos reports de Informix 4gl que permitem ordenações e funções agregadas em after group.

getGroup

public java.lang.Object getGroup()
Método que devolve o grupo


getGroupValue

public java.lang.Object getGroupValue()
Método que devolve o valor do campo da nova chave

Returns:
valor do campo da nova chave

gotoLine

public void gotoLine(int linha)
Posiciona-se na linha dada como parâmetro

Parameters:
linha - linha onde o cursor vai posicionar-se

getColNo

public int getColNo()
Método que devolve o número da coluna corrente

Returns:
numero da coluna corrente

getLineNo

public int getLineNo()
Método que devolve o número da linha corrente

Returns:
numero da linha corrente

gotoColumn

public void gotoColumn(int coluna)
Posiciona-se na coluna dada como parâmetro

Parameters:
coluna - coluna onde o cursor vai posicionar-se

print

public void print(java.lang.String str)
Imprime a string enviada na coluna passada como parâmetro e na linha corrente

Parameters:
str - Texto a imprimir

print

public void print(java.lang.String str,
                  int tFont)
Imprime a string enviada na coluna passada como parâmetro e na linha corrente, mudando-lhe o tamanho da font

Parameters:
str - Texto a imprimir
tFont - Tamanho da font

println

public void println(java.lang.String str)
Imprime a string enviada na coluna passada como parâmetro na linha corrente e muda de linha

Parameters:
str - Texto a imprimir

newLine

public void newLine()
Nova linha no report

Preocupa-se em tratar dos headers e trailers


newPage

public void newPage()
Nova página


setLineno

public void setLineno(int linha)
Reposiciona-se na linha dada como argumento. Vai tratar as mudanças de página e afins

Parameters:
linha - Numero da linha para onde vai ser posicionado o cursor de escrita

addFglReportListener

public void addFglReportListener(FglReportListener reportListener)
                          throws java.util.TooManyListenersException
Adiciona um listener dos eventos do report

Parameters:
reportListener - Listener a adicionar ao report
Throws:
java.util.TooManyListenersException

removeFglReportListener

public void removeFglReportListener(FglReportListener reportListener)
Remove um listener para os eventos do report

Parameters:
reportListener - Listener de eventos a remover

clearFglReportListener

public void clearFglReportListener()
Apaga todos os report Listeners


finishReport

public void finishReport()
Termina o report fechando o ficheiro se for caso disso ou apenas mudando as variáveis do objecto (se Stream)


printBold

public void printBold(java.lang.String str)
Imprime a string enviada na coluna passada como parâmetro e na linha corrente, afectando a sua fonte para Bold

Parameters:
str - Texto a imprimir

printBold

public void printBold(java.lang.String str,
                      int tFont)
Imprime a string enviada na coluna passada como parâmetro e na linha corrente, afectando a sua fonte para Bold e muda a tamanho desta mesma

Parameters:
str - Texto a imprimir
tFont - Tamanho a imprimir

printBox

public void printBox(int num_colunas,
                     int num_linhas)
Imprime uma box na linha e coluna corrente

Parameters:
num_colunas - Numero de caracteres que cabe dentro da box
num_linhas - Numero de linhas que cabe dentro da box

addObject

public void addObject(java.lang.Object obj)
Acrescenta o objecto nao grafico ao buffer de escrita do report

Parameters:
obj - Objecto nao grafico a ser incluido no report

getPageNo

public int getPageNo()
Método que devolve o número da página corrente

Returns:
Numero de página corrente

getFirstPageHeaderLen

public int getFirstPageHeaderLen()
Metodo que devolve o tamanho do Header da primeira pagina

Returns:
Numero de linhas do Header da primeira pagina

getPageHeaderLen

public int getPageHeaderLen()
Metodo que devolve o tamanho do Header das outras paginas

Returns:
Numero de linhas do Header das outras paginas

getPageTrailerLen

public int getPageTrailerLen()
Metodo que devolve o tamanho do Trailer do report

Returns:
Numero de linhas do Trailer do report

getPageLen

public int getPageLen()
Metodo que devolve o numero de linhas das páginas do report

Returns:
Numero de linhas das páginas do report

setPageWidth

public void setPageWidth(int tam)
Metodo que define o numero de colunas de um report

Parameters:
tam - Numero de colunas do report

getPageWidth

public int getPageWidth()
Metodo que devolve o numero de colunas do report

Returns:
Numero de colunas do report

setNomeFont

public void setNomeFont(java.lang.String nFont)
Define o nome da font nas impressões (Courier, Times New Roman, Arial etc)

Parameters:
nFont - Nome da font

setTamanhoFont

public void setTamanhoFont(int tFont)
Define o tamanho da font nas impressões

Parameters:
tFont - Tamanho da font

setFirstPageHeaderLength

public void setFirstPageHeaderLength(int tam)
Define o tamanho do FirstPageHeader

Parameters:
tam - Valor numérico em linhas

setPageHeaderLength

public void setPageHeaderLength(int tam)
Define o tamanho do PageHeader

Parameters:
tam - Valor numérico em linhas

setPageLen

public void setPageLen(int tam)
Define o tamanho da Página

Parameters:
tam - Valor do numero de linhas da página

setPageTrailerLength

public void setPageTrailerLength(int tam)
Define o tamanho do PageTrailer

Parameters:
tam - Valor numérico em linhas

writeReport

public void writeReport(java.lang.String dirName,
                        java.lang.String fileName)
Escreve o report produzido ate essa altura

Parameters:
dirName - Nome da directoria para onde vai ser escrito o report
fileName - Nome do ficheiro para onde vai ser escrito o report