Java Doc for FieldImpl.java in  » Development » ivatamasks » com » ivata » mask » field » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Development » ivatamasks » com.ivata.mask.field 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   com.ivata.mask.field.FieldImpl

FieldImpl
public class FieldImpl implements Field,Serializable(Code)
This is the default implementation of an ivata masks field. Don't use this class directly, use the Field interface.
author:
   Colin MacLeod
since:
   ivata masks 0.1 (2004-05-15) since:
   href='mailto:colin.macleod@ivata.com'>colin.macleod@ivata.com
See Also:   Field



Constructor Summary
public  FieldImpl(Field parentParam, Field extendedFieldParam, MaskFactory maskFactoryParam)
     Construct a field with the given parent or inherited field.

Method Summary
final public  PropertiesgetChoiceProperties()
     If this field represents a combo (select) type, returns the choices as a Properties instance.
final public  ListgetChoicePropertyKeys()
     If this field represents a combo (select) type, returns the choice keys as a List of String instances.
final public  ClassgetDOClass()
     Get the data object class for this field, if appropriate.
final public  StringgetDefaultValue()
     Get the default value for this field.
public  StringgetLabelKey()
     Get the key to used as a field label for this field.
final public  StringgetName()
     Id of just this field - equivalent to the field name.
final public  FieldgetParent()
    

Get the field which contains this one.

final public  StringgetPath()
    

Return the full path to this field, including the ids of parent fields separated by '.' characters.

final public  StringgetType()
     Indicates what sort of data this field should hold.
final public  MaskgetValueObjectMask()
    

If this field represents a value object, get the mask associated with this value object.

public  booleanisDisplayOnly()
     Get whether or not this field can be amended.
public  booleanisHidden()
     true if this field is hidden.
final public  booleanisMandatory()
    

Is this field is required or optional?

true if this field is required and must have anon- null, non-empty value.
public  booleanisOneToOne()
     If this field represents another value object, but the relationship with its container is one-to-one, then it can be included in the parent's mask directly.
public  voidsetChoiceProperties(Properties choicePropertiesParam)
    
public  voidsetChoicePropertyKeys(List choicePropertyKeysParam)
    
public  voidsetDOClass(Class classParam)
    
public  voidsetDefaultValue(String defaultValueParam)
    
public  voidsetDisplayOnly(boolean displayOnlyParam)
    
public  voidsetHidden(boolean hiddenParam)
    
public  voidsetLabelKey(String labelKeyParam)
    
public  voidsetMandatory(boolean mandatoryParam)
    
public  voidsetName(String nameParam)
    
public  voidsetOneToOne(boolean oneToOneParam)
    
public  voidsetParent(Field parentParam)
    
public  voidsetType(String typeParam)
    
final public  StringtoString()
     Overridden to return the field name.


Constructor Detail
FieldImpl
public FieldImpl(Field parentParam, Field extendedFieldParam, MaskFactory maskFactoryParam)(Code)
Construct a field with the given parent or inherited field.
Parameters:
  parentParam - The field whose characteristics this one inherits, if theyhave not been set directly.
Parameters:
  extendedFieldParam - field defined by an explicit "extends" attribute in theconfiguration.
Parameters:
  maskFactoryParam - This mask factory is used to retrieve the mask for this field,if the field represents a value object.




Method Detail
getChoiceProperties
final public Properties getChoiceProperties()(Code)
If this field represents a combo (select) type, returns the choices as a Properties instance. Properties instance representing the possiblevalues.



getChoicePropertyKeys
final public List getChoicePropertyKeys()(Code)
If this field represents a combo (select) type, returns the choice keys as a List of String instances. List of String instancesrepresenting the key values of all choice options.



getDOClass
final public Class getDOClass()(Code)
Get the data object class for this field, if appropriate. data object class if this field links to a data object, otherwisenull.



getDefaultValue
final public String getDefaultValue()(Code)
Get the default value for this field. If no default has been defined for this field, is null. default value for this field, or null if none isdefined.



getLabelKey
public String getLabelKey()(Code)
Get the key to used as a field label for this field. This key can be matched against the application resources messages to get the text in the correct language for the current locale. Returns the label message key.



getName
final public String getName()(Code)
Id of just this field - equivalent to the field name. Id of just this field - equivalent to the field name.



getParent
final public Field getParent()(Code)

Get the field which contains this one.

Field which contains this field, or null if thisis a top-level field.



getPath
final public String getPath()(Code)

Return the full path to this field, including the ids of parent fields separated by '.' characters.

Full path to this field, to uniquely identify it within thesystem.



getType
final public String getType()(Code)
Indicates what sort of data this field should hold. type of the field, from one of the TYPE_ values inthe Fieldinterface.



getValueObjectMask
final public Mask getValueObjectMask()(Code)

If this field represents a value object, get the mask associated with this value object.

Mask associated with this value object or null ifthis field is not a value object.
See Also:   com.ivata.mask.field.Field.getMask



isDisplayOnly
public boolean isDisplayOnly()(Code)
Get whether or not this field can be amended. Useful for automatically generated fields such as timestamps. true if the field cannot be manually changed.



isHidden
public boolean isHidden()(Code)
true if this field is hidden. Otherwise, false. Returns whether or not the field is hidden.



isMandatory
final public boolean isMandatory()(Code)

Is this field is required or optional?

true if this field is required and must have anon- null, non-empty value. Otherwise,false for an optional field.



isOneToOne
public boolean isOneToOne()(Code)
If this field represents another value object, but the relationship with its container is one-to-one, then it can be included in the parent's mask directly. true if this field should be displayed directlyin the mask of the parent field.



setChoiceProperties
public void setChoiceProperties(Properties choicePropertiesParam)(Code)
Refer to FieldImpl.getChoiceProperties .
Parameters:
  choicePropertiesParam - Refer to FieldImpl.getChoiceProperties.



setChoicePropertyKeys
public void setChoicePropertyKeys(List choicePropertyKeysParam)(Code)
Refer to FieldImpl.getChoicePropertyKeys .
Parameters:
  choicePropertyKeysParam - Refer to FieldImpl.getChoicePropertyKeys.



setDOClass
public void setDOClass(Class classParam)(Code)
Refer to FieldImpl.getDOClass .
Parameters:
  classParam - Refer to FieldImpl.getDOClass.



setDefaultValue
public void setDefaultValue(String defaultValueParam)(Code)
Refer to FieldImpl.getDefaultValue .
Parameters:
  defaultValueParam - Refer to FieldImpl.getDefaultValue.



setDisplayOnly
public void setDisplayOnly(boolean displayOnlyParam)(Code)
Refer to FieldImpl.isDisplayOnly .
Parameters:
  displayOnlyParam - Refer to FieldImpl.isDisplayOnly.



setHidden
public void setHidden(boolean hiddenParam)(Code)
Refer to FieldImpl.getHidden .
Parameters:
  hiddenParam - Refer to FieldImpl.getHidden.



setLabelKey
public void setLabelKey(String labelKeyParam)(Code)
Refer to FieldImpl.getLabelKey .
Parameters:
  labelKeyParam - Refer to FieldImpl.getLabelKey.



setMandatory
public void setMandatory(boolean mandatoryParam)(Code)
Refer to FieldImpl.getMandatory .
Parameters:
  mandatoryParam - Refer to FieldImpl.getMandatory.



setName
public void setName(String nameParam)(Code)
Refer to FieldImpl.getName .
Parameters:
  nameParam - Refer to FieldImpl.getName.



setOneToOne
public void setOneToOne(boolean oneToOneParam)(Code)
Refer to FieldImpl.isOneToOne .
Parameters:
  oneToOneParam - Refer to FieldImpl.isOneToOne.



setParent
public void setParent(Field parentParam)(Code)
Refer to FieldImpl.getParent .
Parameters:
  parentParam - Refer to FieldImpl.getParent.



setType
public void setType(String typeParam)(Code)
Refer to FieldImpl.getType .
Parameters:
  typeParam - Refer to FieldImpl.getType.



toString
final public String toString()(Code)
Overridden to return the field name. the field name.



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.