pt.despodata.java.ddata
Interface IDHtmlDataControl

All Known Implementing Classes:
DHtmlDataControl

public interface IDHtmlDataControl

DHtmlDataControl.java Extends DDataControl for HTML manager of record Set(s) Created: Tue Aug 29 10:38:54 2000

Version:
1.0
Author:
Paulo Carmo

Field Summary
static java.lang.String SEPARATOR
          Separador usado no nome dos parametros, para separa o nome do parametro do numero da linha a que este corresponde.
 
Method Summary
 void addAllColumnsToVisualField()
          Add a visual field for each column
 void addDescription(java.lang.String columnName, java.lang.String code, java.lang.String descr)
          Adiciona uma nova descricao associada a um determinado codigo.
 void addDescription(java.lang.String columnName, java.lang.String vfName, java.lang.String code, java.lang.String descr)
          Adiciona uma nova descricao associada a um determinado codigo.
 void addReferencedColumn(java.lang.String columnName, java.lang.String tableName, java.lang.String description, java.lang.String code)
          Adiciona uma nova descricao a lista de descricoes de um campo visual,
 void addReferencedColumn(java.lang.String columnName, java.lang.String vfName, java.lang.String tableName, java.lang.String description, java.lang.String code)
          Adiciona uma nova descricao a lista de descricoes de um campo visual.
 void addVisualField(java.lang.String columnName)
          Add a new visual field to the virtual table
 void addVisualField(java.lang.String columnName, int width, int height, int visibleWidth, int visibleHeight, int fieldType, int fieldFontSize)
          Adiciona um novo campo visual com o nome da propria coluna.
 void addVisualField(java.lang.String columnName, java.lang.String fieldName, int width, int height, int fieldType)
          Add a new visual field to the virtual table
 void addVisualField(java.lang.String columnName, java.lang.String fieldName, int width, int height, int visibleWidth, int visibleHeight, int fieldType, int fieldFontSize)
          Adiciona um novo campo visual a uma determinada coluna.
 java.util.ArrayList createDHtmlArray()
          Cria um ArrayList com os DHtmlDataControl's a actualizar.
 java.lang.String getButtonText()
          Get the value of buttonText.
 IDDataControlField getColumn(java.lang.String columnName)
          Devolve uma estrutura com a representacao de uma coluna.
 java.lang.String getColumnName(java.lang.String vfName)
          Devolve o nome da primeira coluna que tiver um dado campo visual
 java.util.Enumeration getColumnsNames()
          Constroi uma lista com os nomes das colunas.
 java.lang.String getDateFormat()
          Get the value of dateFormat.
 java.lang.String getFormHeader()
          Get the value of tableHeader.
 java.lang.String getFormName()
          Get the value of formName.
 java.lang.String getFormTarget()
          Get the value of formTarget.
 java.lang.String[] getRefField(java.lang.String columnName, java.lang.String vfName)
          Devolve o nome do campo visual que contem o codigo deste campo visual.
 javax.servlet.http.HttpSession getSession()
          Devolve a sessao usada na criacao da classe.
 int getTableBorder()
          Get the value of border.
 java.lang.String getTableHeader()
          Get the value of formHeader.
 IDDataVisualField getVisualField(java.lang.String columnName)
          Devolve o visualField usado por defeito.
 IDDataVisualField getVisualField(java.lang.String columnName, java.lang.String fieldName)
          Devolve o visualField correspondente a uma dada coluna
 java.lang.String getVisualFieldName(java.lang.String columnName)
          Devolve o nome de um campo visualizavel usado por defeito.
 java.util.Enumeration getVisualFieldsNames()
          Constroi uma lista com os nomes dos campos visualizaveis de todas as colunas.
 java.util.Enumeration getVisualFieldsNames(java.lang.String columnName)
          Constroi uma lista com os nomes dos campos visualizaveis de uma determinada coluna.
 boolean isReference(java.lang.String columnName, java.lang.String vfName)
          Verifica se um campo visual pertence ao DHtmlDataControl, ou se e uma campo que faz referencia para outra tabela.
 boolean isVisualField(java.lang.String columnName)
          Verifica se um campo e visualizavel
 void removeVisualField(java.lang.String fieldName)
          Removes a visual field from the virtual table.
 void rmDescription(java.lang.String columnName, java.lang.String vfName, java.lang.String code)
          Remove a value from the list of values.
 void rmReferencedColumn(java.lang.String columnName, java.lang.String vfName, java.lang.String description)
          Remove a value from the list of values.
 void setButtonText(java.lang.String v)
          Set the value of buttonText.
 void setColumnFileName(java.lang.String columnName, java.lang.String columnFileName)
          Devolve o nome da columa que contem o nome do ficheiro.
 void setDateFormat(java.lang.String v)
          Set the value of dateFormat.
 void setEditable(java.lang.String columnName, java.lang.String fieldName, boolean editable)
          Torna o campo editavel, ou nao editavel.
 void setFormHeader(java.lang.String v)
          Set the value of formHeader.
 void setFormName(java.lang.String v)
          Set the value of formName.
 void setFormTarget(java.lang.String v)
          Set the value of formTarget.
 void setRefField(java.lang.String columnName, java.lang.String vfName, java.lang.String refColumnName, java.lang.String refVFName)
          Altera a identificacao do campo visual que contem o codigo deste campo visual.
 void setRefWhereStr(java.lang.String columnName, java.lang.String vfName, java.lang.String v)
          Set the value of refWhereStr.
 void setTableBorder(int v)
          Set the value of border.
 void setTableHeader(java.lang.String v)
          Set the value of tableHeader.
 void setTableName(java.lang.String tableName)
          Set BD table name.
 java.lang.String showDataAsCustom(int row, java.lang.String columnName)
          Mostra os dados de uma coluna, sem estarrem formatados.
 java.lang.String showDataAsCustom(int row, java.lang.String columnName, java.lang.String fieldName)
          Mostra os dados de uma coluna, sem estarrem formatados.
 java.lang.String showDataAsCustomForm(int row, java.lang.String columnName)
          Mostra uma entrada de dados de um form.
 java.lang.String showDataAsCustomForm(int row, java.lang.String columnName, java.lang.String fieldName)
          Mostra uma entrada de dados de um form.
 java.lang.String showDataAsCustomForm(java.lang.String field)
          Show data as a from
 java.lang.String showDataAsCustomTable(int row, java.lang.String name, java.lang.String link)
          Mostra o campo por defeito, sob a forma de uma celula de uma tabela em Html.
 java.lang.String showDataAsCustomTable(int row, java.lang.String columnName, java.lang.String fieldName, java.lang.String link)
          Mostra um campo sob a forma de uma celula de uma tabela em Html.
 java.lang.String showDataAsForm(int row)
          Show data from a data base table on a htlm form
 java.lang.String showDataAsTable(int firstRow, int numRows)
          Show data from a data base table on a htlm table
 java.lang.String showNewDataAsCustomForm(int row, java.lang.String name, java.lang.String fieldName)
          Show data form input field
 java.lang.String showNewDataAsForm()
          Shows a new and clean html form.
 void submitFormData(int row)
          Submit a form data to the data base.
 

Field Detail

SEPARATOR

public static final java.lang.String SEPARATOR
Separador usado no nome dos parametros, para separa o nome do parametro do numero da linha a que este corresponde.

Method Detail

addAllColumnsToVisualField

public void addAllColumnsToVisualField()
Add a visual field for each column


addDescription

public void addDescription(java.lang.String columnName,
                           java.lang.String code,
                           java.lang.String descr)
Adiciona uma nova descricao associada a um determinado codigo.

Parameters:
columnName - Nome da coluna.
code - Codigo da descricao
descr - Descricao.

addDescription

public void addDescription(java.lang.String columnName,
                           java.lang.String vfName,
                           java.lang.String code,
                           java.lang.String descr)
Adiciona uma nova descricao associada a um determinado codigo.

Parameters:
columnName - Nome da coluna.
vfName - Nome do campo visualizavel.
code - Codigo da descricao
descr - Descricao.

addReferencedColumn

public void addReferencedColumn(java.lang.String columnName,
                                java.lang.String tableName,
                                java.lang.String description,
                                java.lang.String code)
Adiciona uma nova descricao a lista de descricoes de um campo visual,

Parameters:
columnName - Nome da coluna.
tableName - Tabela onde esta a descricao e o codigo.
description - Nome da coluna onde esta a descricao.
code - Nome da coluna onde esta o codigo da descricao.

addReferencedColumn

public void addReferencedColumn(java.lang.String columnName,
                                java.lang.String vfName,
                                java.lang.String tableName,
                                java.lang.String description,
                                java.lang.String code)
Adiciona uma nova descricao a lista de descricoes de um campo visual.

Parameters:
columnName - Nome da coluna.
vfName - Nome do campo visualizavel.
tableName - Tabela onde esta a descricao e o codigo.
description - Nome da coluna onde esta a descricao.
code - Nome da coluna onde esta o codigo da descricao.

addVisualField

public void addVisualField(java.lang.String columnName,
                           java.lang.String fieldName,
                           int width,
                           int height,
                           int fieldType)
Add a new visual field to the virtual table

Parameters:
height - Altura do campo.
width - Comprimento do campo.
fieldType - Tipo de campo.

addVisualField

public void addVisualField(java.lang.String columnName,
                           int width,
                           int height,
                           int visibleWidth,
                           int visibleHeight,
                           int fieldType,
                           int fieldFontSize)
Adiciona um novo campo visual com o nome da propria coluna.

Parameters:
height - Altura do campo.
visibleHeight - Altura visivel do campo.
width - Comprimento do campo.
visibleWidth - Comprimento visivel do campo.
fieldType - Tipo de campo.
fieldFontSize - Tamanho da fonte usada no campo.

addVisualField

public void addVisualField(java.lang.String columnName,
                           java.lang.String fieldName,
                           int width,
                           int height,
                           int visibleWidth,
                           int visibleHeight,
                           int fieldType,
                           int fieldFontSize)
Adiciona um novo campo visual a uma determinada coluna.

Parameters:
height - Altura do campo.
visibleHeight - Altura visivel do campo.
width - Comprimento do campo.
visibleWidth - Comprimento visivel do campo.
fieldType - Tipo de campo.
fieldFontSize - Tamanho da fonte usada no campo.

addVisualField

public void addVisualField(java.lang.String columnName)
Add a new visual field to the virtual table

Parameters:
columnName - Nome da coluna.

createDHtmlArray

public java.util.ArrayList createDHtmlArray()
Cria um ArrayList com os DHtmlDataControl's a actualizar. Este meto pode e deve ser redefenido nop casom de se pretender actualizar varias tabelas (DHtmlDatacontrol) de cada vez.

Returns:
um arrayList constituido por instancias de "DHtmlDataControl".

isVisualField

public boolean isVisualField(java.lang.String columnName)
Verifica se um campo e visualizavel

Parameters:
columnName - Nome do campo
Returns:
true Se o campo for Visualizavel, false caso contrario

getButtonText

public java.lang.String getButtonText()
Get the value of buttonText.

Returns:
Value of buttonText.

getColumn

public IDDataControlField getColumn(java.lang.String columnName)
Devolve uma estrutura com a representacao de uma coluna.

Parameters:
columnName - O nome da coluna.
Returns:
uma representacao da coluna.

getColumnName

public java.lang.String getColumnName(java.lang.String vfName)
Devolve o nome da primeira coluna que tiver um dado campo visual

Parameters:
vfName - O nome do campo visual.
Returns:
O nome da coluna correspondente que contem o campo visual.

getColumnsNames

public java.util.Enumeration getColumnsNames()
Constroi uma lista com os nomes das colunas.

Returns:
Um objecto do tipo Enumeration com os nomes das colunas.

getDateFormat

public java.lang.String getDateFormat()
Get the value of dateFormat.

Returns:
Value of dateFormat.

getFormHeader

public java.lang.String getFormHeader()
Get the value of tableHeader.

Returns:
Value of tableHeader.

getFormName

public java.lang.String getFormName()
Get the value of formName.

Returns:
Value of formName.

getFormTarget

public java.lang.String getFormTarget()
Get the value of formTarget.

Returns:
Value of formTarget.

getSession

public javax.servlet.http.HttpSession getSession()
Devolve a sessao usada na criacao da classe.


getTableBorder

public int getTableBorder()
Get the value of border.

Returns:
Value of border.

getTableHeader

public java.lang.String getTableHeader()
Get the value of formHeader.

Returns:
Value of formHeader.

getVisualField

public IDDataVisualField getVisualField(java.lang.String columnName)
Devolve o visualField usado por defeito.

Parameters:
columnName - O nome da coluna.
Returns:
Uma coluna visualizavel

getVisualField

public IDDataVisualField getVisualField(java.lang.String columnName,
                                        java.lang.String fieldName)
Devolve o visualField correspondente a uma dada coluna

Parameters:
columnName - O nome da coluna.
fieldName - O nome de um campo visual.
Returns:
Uma coluna visualizavel

getVisualFieldName

public java.lang.String getVisualFieldName(java.lang.String columnName)
Devolve o nome de um campo visualizavel usado por defeito.

Parameters:
columnName - O nome da coluna.
Returns:
O nome do campo visualizavel, usado por defeito.

getVisualFieldsNames

public java.util.Enumeration getVisualFieldsNames()
Constroi uma lista com os nomes dos campos visualizaveis de todas as colunas.

Returns:
Um objecto do tipo Enumeration com os nomes dos campos visualizaveis.

getVisualFieldsNames

public java.util.Enumeration getVisualFieldsNames(java.lang.String columnName)
Constroi uma lista com os nomes dos campos visualizaveis de uma determinada coluna.

Returns:
Um objecto do tipo Enumeration com os nomes dos campos visualizaveis.

isReference

public boolean isReference(java.lang.String columnName,
                           java.lang.String vfName)
                    throws DDataException
Verifica se um campo visual pertence ao DHtmlDataControl, ou se e uma campo que faz referencia para outra tabela.

Parameters:
columnName - O nome da coluna.
vfName - O nome do campo visual.
Returns:
true caso o campo visual seja uma referencia para uma coluna de outra tabela, false caso contrario.
Throws:
DDataException

setButtonText

public void setButtonText(java.lang.String v)
Set the value of buttonText.

Parameters:
v - Value to assign to buttonText.

setColumnFileName

public void setColumnFileName(java.lang.String columnName,
                              java.lang.String columnFileName)
Devolve o nome da columa que contem o nome do ficheiro.

Parameters:
columnName - Nome da coluna.

setDateFormat

public void setDateFormat(java.lang.String v)
Set the value of dateFormat.

Parameters:
v - Value to assign to dateFormat.

setEditable

public void setEditable(java.lang.String columnName,
                        java.lang.String fieldName,
                        boolean editable)
Torna o campo editavel, ou nao editavel.

Parameters:
columnName - Nome da coluna.
fieldName - O nome do campo visual da coluna
editable - true se o campo fôr editável, false caso contrário.

setFormHeader

public void setFormHeader(java.lang.String v)
Set the value of formHeader.

Parameters:
v - Value to assign to formHeader.

setFormName

public void setFormName(java.lang.String v)
Set the value of formName.

Parameters:
v - Value to assign to formName.

setFormTarget

public void setFormTarget(java.lang.String v)
Set the value of formTarget.

Parameters:
v - Value to assign to formTarget.

setRefWhereStr

public void setRefWhereStr(java.lang.String columnName,
                           java.lang.String vfName,
                           java.lang.String v)
Set the value of refWhereStr.

Parameters:
columnName - Nome da coluna.
vfName - Nome do campo visual.
v - Value to assign to refWhereStr.

setTableBorder

public void setTableBorder(int v)
Set the value of border.

Parameters:
v - Value to assign to border.

setTableHeader

public void setTableHeader(java.lang.String v)
Set the value of tableHeader.

Parameters:
v - Value to assign to tableHeader.

setTableName

public void setTableName(java.lang.String tableName)
Set BD table name. Also changes the html table header and the html form header.

Returns:
Value of formTarget.

showDataAsCustom

public java.lang.String showDataAsCustom(int row,
                                         java.lang.String columnName)
Mostra os dados de uma coluna, sem estarrem formatados.

Parameters:
row - Numero da linha da tabela.
columnName - Nome da coluna da tabela.

showDataAsCustom

public java.lang.String showDataAsCustom(int row,
                                         java.lang.String columnName,
                                         java.lang.String fieldName)
Mostra os dados de uma coluna, sem estarrem formatados.

Parameters:
row - Numero da linha da tabela.
columnName - Nome da coluna da tabela.
fieldName - Nome do campo visualizavel da coluna.

showDataAsCustomForm

public java.lang.String showDataAsCustomForm(java.lang.String field)
Show data as a from

Parameters:
field - Field name.

showDataAsCustomForm

public java.lang.String showDataAsCustomForm(int row,
                                             java.lang.String columnName)
Mostra uma entrada de dados de um form.

Parameters:
row - Numero da linha.
columnName - Nome da coluna.

showDataAsCustomForm

public java.lang.String showDataAsCustomForm(int row,
                                             java.lang.String columnName,
                                             java.lang.String fieldName)
Mostra uma entrada de dados de um form.

Parameters:
row - Numero da linha.
columnName - Nome da coluna.
fieldName - Nome do campo visual.

showDataAsCustomTable

public java.lang.String showDataAsCustomTable(int row,
                                              java.lang.String name,
                                              java.lang.String link)
Mostra o campo por defeito, sob a forma de uma celula de uma tabela em Html.

Parameters:
row - Numero da linha da tabela.
link - link que deve ser criado com o valor dos campos.

showDataAsCustomTable

public java.lang.String showDataAsCustomTable(int row,
                                              java.lang.String columnName,
                                              java.lang.String fieldName,
                                              java.lang.String link)
Mostra um campo sob a forma de uma celula de uma tabela em Html.

Parameters:
row - Numero da linha da tabela.
columnName - Nome da coluna na tabela.
fieldName - Nome do campo visual da coluna.
link - link que deve ser criado com o valor dos campos.

showDataAsForm

public java.lang.String showDataAsForm(int row)
Show data from a data base table on a htlm form

Parameters:
row - Numero da linha.

showDataAsTable

public java.lang.String showDataAsTable(int firstRow,
                                        int numRows)
Show data from a data base table on a htlm table

Parameters:
firstRow -
numRows -

showNewDataAsCustomForm

public java.lang.String showNewDataAsCustomForm(int row,
                                                java.lang.String name,
                                                java.lang.String fieldName)
Show data form input field

Parameters:
row - table row number
name - table field name

showNewDataAsForm

public java.lang.String showNewDataAsForm()
Shows a new and clean html form.


submitFormData

public void submitFormData(int row)
Submit a form data to the data base.

Parameters:
row -

removeVisualField

public void removeVisualField(java.lang.String fieldName)
Removes a visual field from the virtual table.

Parameters:
fieldName - Nome da coluna a remover

rmReferencedColumn

public void rmReferencedColumn(java.lang.String columnName,
                               java.lang.String vfName,
                               java.lang.String description)
Remove a value from the list of values.

Parameters:
vfName - Nome da coluna visualizavel.
description - Nome da coluna onde esta a descricao.

rmDescription

public void rmDescription(java.lang.String columnName,
                          java.lang.String vfName,
                          java.lang.String code)
Remove a value from the list of values.

Parameters:
columnName - Nome da coluna.
vfName - Nome do campo visualizavel.
code - Codigo da descricao a remover.

setRefField

public void setRefField(java.lang.String columnName,
                        java.lang.String vfName,
                        java.lang.String refColumnName,
                        java.lang.String refVFName)
Altera a identificacao do campo visual que contem o codigo deste campo visual.


getRefField

public java.lang.String[] getRefField(java.lang.String columnName,
                                      java.lang.String vfName)
Devolve o nome do campo visual que contem o codigo deste campo visual.