pt.despodata.java.ddata
Interface IDDataControlField

All Known Implementing Classes:
DHtmlDataField

public interface IDDataControlField

Version:
$Revision: 1.2 $
Author:
Paulo Carmo
See Also:
IDDataVisualField, DHtmlVisualField

Method Summary
 void addDescription(java.lang.String vfName, java.lang.String code, java.lang.Object descr)
          Adiciona uma descricao a lista de descricoes.
 void addReferencedColumn(java.lang.String vfName, java.lang.String comboboxTableName, java.lang.String comboDescriptionColumn, java.lang.String comboCodeColumn)
          Adiciona uma chave estrangeira a um campo visual.
 void addVisualField(int width, int height, int fieldType)
          Adiciona um novo campo visual a coluna, com o mesmo nome da coluna.
 void addVisualField(int width, int height, int visibleWidth, int visibleHeight, int fieldType, int fieldFontSize)
          Adiciona um novo campo visual com o mesmo nome da coluna.
 void addVisualField(java.lang.String fieldName, int width, int height, int fieldType)
          Add a new visual field to the virtual table
 void addVisualField(java.lang.String fieldName, int width, int height, int visibleWidth, int visibleHeight, int fieldType, int fieldFontSize)
          Adiciona um novo campo visual com um determinado nome.
 void dump()
          Imprime o conteudo do objecto (para debug apenas)
 void dump(java.lang.String _prefix)
          Imprime o conteudo do objecto (para debug apenas)
 java.lang.Object getColumnDefault()
          Get the value of columnDefault.
 java.lang.String getColumnFileName()
          Devolve o nome da columa que contem o nome do ficheiro.
 java.lang.String getColumnName()
          Devolve o nome da coluna.
 int getColumnNumber()
          Get the value of columnNumber.
 java.lang.String getDbDataType()
          Devolve o valor da propriedade do text field.
 IDDataVisualField getDefaultVisualField()
          Devolve o campo visualizavel usado por defeito.
 java.lang.String getModelTableName()
          Devolve o nome da tabela usado pela servlet GetImage.
 java.lang.String getRefWhereStr(java.lang.String vfName)
          Devolve a clausula de where usada para procurar na tabela referenciada.
 IDDataVisualField getVisualField()
          Devolve o visualField usado por defeito.
 IDDataVisualField getVisualField(java.lang.String fieldName)
          Devolve o visualField com um determinado nome.
 java.lang.String getVisualFieldName()
          Devolve o nome do campo visual usado por defeito.
 java.util.Enumeration getVisualFields()
          Devolve todos os campos visuais que existem sobre a coluna representada por esta classe.
 java.util.Enumeration getVisualFieldsNames()
          Constroi uma lista com os nomes dos campos visualizaveis para uma coluna.
 boolean isFk()
          Get the value of fk.
 boolean isModelTableDetail()
          Devolve o nome da tabela usado pela servlet GetImage.
 boolean isReference(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()
          Verifica se uma coluna e visualizavel
 boolean isVisualField(java.lang.String vfName)
          Verifica se existe um campo visualizavel com um dado nome.
 void removeVisualField(java.lang.String fieldName)
          Removes a visual field from the virtual table.
 void setColumnFileName(java.lang.String columnName)
          Devolve o nome da columa que contem o nome do ficheiro.
 void setColumnNumber(int v)
          Set the value of columnNumber.
 void setDbDataType(java.lang.String dbDataType)
          Afecta o tipo de dados (com uma string que o identifica) que o campo recolhe ou mostra
 void setEditable(java.lang.String fieldName, boolean editable)
          Torna o campo editavel, ou nao editavel.
 void setFk(boolean v)
          Set the value of fk.
 void setModelTableName(java.lang.String modelTableName, boolean modelTableDetail)
          Altera o nome da tabela usado pela servlet GetImage.
 void setRefWhereStr(java.lang.String vfName, java.lang.String whereStr)
          Devolve a clausula de where usada para procurar na tabela referenciada.
 void setRequired(boolean required)
          Activa ou desactiva a obrigatoridade do campo.
 void setRequired(java.lang.String vfName, boolean required)
          Activa ou desactiva a obrigatoridade do campo.
 java.lang.String toString()
          Devolve o conteudo do objecto (para debug apenas)
 java.lang.String toString(java.lang.String _prefix)
          Devolve o conteudo do objecto (para debug apenas)
 

Method Detail

addDescription

public void addDescription(java.lang.String vfName,
                           java.lang.String code,
                           java.lang.Object descr)
Adiciona uma descricao a lista de descricoes.

Parameters:
vfName - Nome do campo visual.
code - Codigo da descricao.
descr - Descricao a adicionar.

addReferencedColumn

public void addReferencedColumn(java.lang.String vfName,
                                java.lang.String comboboxTableName,
                                java.lang.String comboDescriptionColumn,
                                java.lang.String comboCodeColumn)
Adiciona uma chave estrangeira a um campo visual.

Parameters:
vfName - Nome do campo visual.
comboboxTableName - Nome da tabela que contem as descricao e os codigos para popular a combobox.
comboDescriptionColumn - Nome da coluna que contem a descricao na tabela 'comboboxTableName'.
comboCodeColumn - Nome da coluna que contem o codigo na tabela 'comboboxTableName'.

addVisualField

public void addVisualField(int width,
                           int height,
                           int fieldType)
Adiciona um novo campo visual a coluna, com o mesmo nome da coluna.

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

addVisualField

public void addVisualField(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(int width,
                           int height,
                           int visibleWidth,
                           int visibleHeight,
                           int fieldType,
                           int fieldFontSize)
Adiciona um novo campo visual com o mesmo nome da 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 fieldName,
                           int width,
                           int height,
                           int visibleWidth,
                           int visibleHeight,
                           int fieldType,
                           int fieldFontSize)
Adiciona um novo campo visual com um determinado nome.

Parameters:
fieldName - Nome do campo visual a adicionar a coluna.
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.

getColumnDefault

public java.lang.Object getColumnDefault()
Get the value of columnDefault.

Returns:
Value of columnDefault.

getColumnFileName

public java.lang.String getColumnFileName()
Devolve o nome da columa que contem o nome do ficheiro.


getColumnName

public java.lang.String getColumnName()
Devolve o nome da coluna.

Returns:
O nome da coluna.

getColumnNumber

public int getColumnNumber()
Get the value of columnNumber.

Returns:
Value of columnNumber.

getDbDataType

public java.lang.String getDbDataType()
Devolve o valor da propriedade do text field.

Returns:
Tipo de dados conforme definido em DDataType.

getDefaultVisualField

public IDDataVisualField getDefaultVisualField()
Devolve o campo visualizavel usado por defeito. Caso exista mais do que um, e gerada uma excepcao.

Returns:
Um campo visualizavel.

getRefWhereStr

public java.lang.String getRefWhereStr(java.lang.String vfName)
Devolve a clausula de where usada para procurar na tabela referenciada.

Parameters:
vfName - Nome do campo visual.
Returns:
A clausula de where usada para procurar na tabela referenciada.

getVisualField

public IDDataVisualField getVisualField()
Devolve o visualField usado por defeito.

Returns:
Uma coluna visualizavel

getVisualField

public IDDataVisualField getVisualField(java.lang.String fieldName)
Devolve o visualField com um determinado nome.

Parameters:
fieldName - O nome do campo. throws DDataException@return Uma coluna visualizavel

getVisualFieldName

public java.lang.String getVisualFieldName()
                                    throws DDataException
Devolve o nome do campo visual usado por defeito. So funciona se so existir um campo visual.

Returns:
O nome do campo visual usado por defeito.
Throws:
DDataException

getVisualFields

public java.util.Enumeration getVisualFields()
Devolve todos os campos visuais que existem sobre a coluna representada por esta classe.


getVisualFieldsNames

public java.util.Enumeration getVisualFieldsNames()
Constroi uma lista com os nomes dos campos visualizaveis para uma coluna.

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

isFk

public boolean isFk()
Get the value of fk.

Returns:
Value of fk.

isReference

public boolean isReference(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:
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

isVisualField

public boolean isVisualField()
Verifica se uma coluna e visualizavel

Returns:
true se a coluna for Visualizavel, false caso contrario

isVisualField

public boolean isVisualField(java.lang.String vfName)
Verifica se existe um campo visualizavel com um dado nome.

Returns:
true se existe um campo visualizavel com um dado nome, falso caso contrario.

setColumnFileName

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

Parameters:
columnName - Nome da coluna.

setColumnNumber

public void setColumnNumber(int v)
Set the value of columnNumber.

Parameters:
v - Value to assign to columnNumber.

setDbDataType

public void setDbDataType(java.lang.String dbDataType)
Afecta o tipo de dados (com uma string que o identifica) que o campo recolhe ou mostra

Parameters:
dbDataType - Tipo de dados devolvido

setEditable

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

Parameters:
editable - true se o campo fôr editável, false caso contrário.

setFk

public void setFk(boolean v)
Set the value of fk.

Parameters:
v - Value to assign to fk.

setRefWhereStr

public void setRefWhereStr(java.lang.String vfName,
                           java.lang.String whereStr)
Devolve a clausula de where usada para procurar na tabela referenciada.

Parameters:
vfName - Nome do campo visual.
whereStr - A clausula de where.
Returns:
A clausula de where usada para procurar na tabela referenciada.

setRequired

public void setRequired(boolean required)
Activa ou desactiva a obrigatoridade do campo.

Parameters:
required - Se for true, o campo e de preenchimento obrigatorio, caso contrario, o campo nao e obrigatorio.

setRequired

public void setRequired(java.lang.String vfName,
                        boolean required)
Activa ou desactiva a obrigatoridade do campo.

Parameters:
vfName - Nome do campo que queremos alterar.
required - Se for true, o campo e de preenchimento obrigatorio, caso contrario, o campo nao e obrigatorio.

removeVisualField

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

Parameters:
fieldName - Nome da coluna a remover

toString

public java.lang.String toString()
Devolve o conteudo do objecto (para debug apenas)


toString

public java.lang.String toString(java.lang.String _prefix)
Devolve o conteudo do objecto (para debug apenas)


dump

public void dump()
Imprime o conteudo do objecto (para debug apenas)


dump

public void dump(java.lang.String _prefix)
Imprime o conteudo do objecto (para debug apenas)


getModelTableName

public java.lang.String getModelTableName()
Devolve o nome da tabela usado pela servlet GetImage.

Returns:
Value of property modelTableName.

isModelTableDetail

public boolean isModelTableDetail()
Devolve o nome da tabela usado pela servlet GetImage.

Returns:
Value of property modelTableName.

setModelTableName

public void setModelTableName(java.lang.String modelTableName,
                              boolean modelTableDetail)
Altera o nome da tabela usado pela servlet GetImage.

Parameters:
modelTableName - New value of property modelTableName.