| java.lang.Object
 com.projity.field.Field
| Constructor Summary | |
| public | Field()
|
| Method Summary | |
| public boolean | build()
| | public void | clearFormula()
| | public Object | clone()
| | public int | compare(Object arg0, Object arg1)
Compare two objects using this field. | | public int | compareTo(Object to)
Compares two fields. | | final public String | convertIdToString(Object id)
| | public Object | convertValueForExport(Object value)
| | public String | convertValueToStringUsingOptions(Object value)
| | public void | copyData(Object to, Object from)
Copies field data from one object to another. | | public static void | copyData(Collection fieldArray, Object to, Object from)
| | public static void | copyData(Object to, Map fromMap)
Copies data from a map which contains Field Ids (e.g. | | public static void | copyData(Map toMap, Object from, Collection fieldArray)
| | public Field | createIndexedField(int index)
| | public static Field | createIntervalField(Field f, Interval interval)
| | public String | dump()
| | public Object | evaluateFormula(Object object)
| | public Object | find(Object key, Collection container)
| | public Object[] | findAllInCollection(Object value, Collection collection)
| | public Object | findFirstInCollection(Object value, Collection collection)
| | public void | fireEvent(Object object, Object source, FieldContext context)
| | public FieldAccessible | getAccessControl()
| | final public String | getAction()
| | public String | getAlias()
| | final public Class | getClazz()
| | public int | getColumnWidth()
| | public int | getColumnWidth(boolean svg)
| | public Object | getCommonValue(Collection collection, boolean useMultipleValue, boolean text)
Given a collection, if each elements shares the same value for this
field, the value is returned, Otherwise null is returned. | | public String | getCommonValueString(Collection collection)
| | public Comparator | getComparator()
| | public Comparator | getComparator(boolean ascending)
| | public String | getDefaultName()
| | public Object | getDefaultValue()
| | public Class | getDisplayType()
| | final public String | getErrorMessage()
| | final public String | getExtraCategory()
| | public OptionsFilter | getFilter()
| | public Format | getFormat()
| | public Format | getFormat(Object object)
| | public int | getGroupSummary()
| | public String | getHelp()
| | public int | getHorizontalAlignment()
| | public String | getId()
| | public String | getIdWithoutPrefix()
| | public int | getIndex()
| | public int | getIndexes()
| | public String | getLabel()
| | public String | getLookupTypes()
| | public String | getMetadataString()
| | public static String | getMetadataStringHeader()
| | public Object | getMultipleValueForType()
| | public String | getName()
| | public Object[] | getOptions(Object object)
| | public String | getProperty()
| | public Range | getRange()
| | public Long | getReferencedId(Object obj)
| | public String | getReferencedIdProperty()
| | public Object | getReferencedObject(Object obj)
| | public String | getReferencedObjectProperty()
| | public double | getScaleFactor()
| | public Select | getSelect()
| | public FieldContext | getSpecialFieldContext()
| | public int | getSummary()
| | public int | getSummaryForGroup()
| | public String | getSummaryType()
| | public SummaryVisitor | getSummaryVisitor(int summary, boolean forceDeep)
| | public SummaryVisitor | getSummaryVisitor(boolean forceDeep)
| | public int | getSvgColumnWidth()
| | final public String | getText(Object object, FieldContext context)
| | final public String | getText(Node node, WalkersNodeModel nodeModel, FieldContext context)
| | final public String | getText(ObjectRef objectRef, FieldContext context)
| | public int | getTextWidth(Object object, FieldContext context)
| | public int | getTextWidth()
| | final public String | getUrl()
| | public Object | getValue(Node node, WalkersNodeModel nodeModel, FieldContext context)
| | public Object | getValue(ObjectRef objectRef, FieldContext context)
| | public Object | getValue(Object object)
| | public Object | getValue(Object object, FieldContext context)
| | public Object | getValueFromProperty(Object obj)
| | public boolean | hasDynamicSelect()
| | public boolean | hasFilter()
| | public boolean | hasOptions()
| | public boolean | hasSummary()
| | public String | internalTypeName()
| | public void | invokeAction(Object obj)
| | public boolean | isApplicable(Object object)
| | public boolean | isApplicable(Class type)
| | public boolean | isApplicable(Class[] types)
| | public boolean | isAuthorized(int role)
| | public boolean | isBoolean()
| | public boolean | isCallValidateOnClear()
| | public boolean | isCantReset()
| | public boolean | isComparable()
| | public boolean | isCustom()
| | public boolean | isDate()
| | public boolean | isDateOnly()
| | final public boolean | isDirtiesWholeDocument()
| | public boolean | isDontLimitToChoices()
| | public boolean | isDuration()
| | public boolean | isDurationOrWork()
| | final public boolean | isDynamicOptions()
| | public boolean | isEndValue()
| | public boolean | isExtra()
| | public boolean | isFormula()
| | public boolean | isGraphical()
| | public boolean | isHasFilter()
| | public boolean | isHasOptions()
| | final public boolean | isHasToolTip()
| | public boolean | isHidden(Object object, FieldContext context)
| | public boolean | isHideZeroValues()
| | final public boolean | isHyperlink()
| | final public boolean | isImage()
| | public boolean | isIndexed()
| | public boolean | isLink()
| | final public boolean | isMap()
| | public boolean | isMemo()
| | public boolean | isMoney()
| | public boolean | isNameField()
| | public boolean | isNumber()
| | public boolean | isPassword()
| | public boolean | isPercent()
| | public boolean | isRate()
| | public boolean | isReadOnly()
Returns the readOnly. | | public boolean | isReadOnly(Node node, WalkersNodeModel nodeModel, FieldContext context)
See if a node is read only. | | public boolean | isReadOnly(ObjectRef objectRef, FieldContext context)
| | public boolean | isReadOnly(Object object, FieldContext context)
| | public boolean | isScalar()
| | public boolean | isServer()
| | public boolean | isStandardType()
| | public boolean | isStartValue()
| | public boolean | isValidChoice(String textValue)
| | final public boolean | isValidOnObjectCreate()
| | public boolean | isVector()
| | public boolean | isWork()
| | public boolean | isZero(Object value)
| | public boolean | isZeroBasedIndex()
| | public Object | mapStringToValue(String textValue)
| | public String | mapValueToString(Object value)
| | protected Object | preprocessText(Object object, String textValue, FieldContext context)
| | public void | setAccessControl(FieldAccessible accessControl)
| | final public void | setAction(String action)
| | public void | setAlias(String alias)
| | public void | setBoundsField(String boundsField)
| | public void | setCallValidateOnClear(boolean callValidateOnClear)
| | public void | setCantReset(boolean cantReset)
| | final public void | setClass(Class clazz)
| | public void | setColumnWidth(int columnWidth)
| | final public void | setComparator(Comparator comparator)
| | public void | setCustom(boolean custom)
| | public void | setDate(boolean date)
| | public void | setDateOnly(boolean dateOnly)
| | public void | setDefaultValue(Object defaultValue)
| | final public void | setDirtiesWholeDocument(boolean dirtiesWholeDocument)
| | public void | setDontLimitToChoices(boolean dontLimitToChoices)
| | public void | setDuration(boolean duration)
| | final public void | setDynamicOptions(boolean dynamicOptions)
| | public void | setEndValue(boolean endValue)
| | final public void | setEnglishName(String englishName)
| | final public void | setErrorMessage(String errorMessage)
| | final public void | setExternalType(Class externalType)
| | final public void | setExtraCategory(String extraCategory)
| | public void | setFilter(OptionsFilter filter)
| | public void | setFinder(String finder)
| | public void | setFormula(String formulaName, String variableName, String formulaText)
| | public void | setGraphical(boolean graphical)
| | final public void | setGroupSum(String summaryType)
| | final public void | setHasToolTip(boolean hasToolTip)
| | public void | setHelp(String help)
| | public void | setHideZeroValues(boolean hideZeroValues)
| | public void | setId(String id)
| | final public void | setImage(boolean image)
| | public void | setIndex(int index)
| | public void | setIndexes(int indexes)
| | public boolean | setInternalValue(Object object, Object value, FieldContext context)
| | public void | setLookupTypes(String lookupTypes)
| | public void | setMemo(boolean memo)
| | public void | setMoney(boolean money)
| | final public void | setName(String name)
| | public void | setNameField(boolean nameField)
| | public void | setPassword(boolean password)
| | public void | setPercent(boolean percent)
| | final public void | setProperty(String property)
| | public void | setRange(Range range)
| | public void | setRate(boolean rate)
| | public void | setReadOnly(boolean readOnly)
| | public void | setReferencedIdProperty(String referencedIdProperty)
| | public void | setReferencedObjectProperty(String referencedObjectProperty)
| | public void | setScalar(boolean scalar)
| | final public void | setSelect(Select select)
| | public void | setServer(boolean server)
| | public void | setSpecialFieldContext(FieldContext specialFieldContext)
| | public void | setStartValue(boolean startValue)
| | final public void | setSum(String summaryType)
| | final public void | setSummary(String summaryType)
| | public void | setSvgColumnWidth(int svgColumnWidth)
| | final public void | setText(Object object, String textValue, FieldContext context)
| | final public void | setText(Node node, WalkersNodeModel nodeModel, String textValue, FieldContext context)
| | final public void | setText(ObjectRef objectRef, String textValue, FieldContext context)
| | final public void | setTextWidth(int textWidth)
| | public void | setType(String type)
| | final public void | setUrl(String url)
| | final public void | setValidOnObjectCreate(boolean validOnObjectCreate)
| | public void | setValue(Node node, WalkersNodeModel nodeModel, Object source, Object value, FieldContext context)
| | public void | setValue(Object object, Object source, Object value, FieldContext context)
| | public boolean | setValue(Object object, Object source, Object value)
| | public void | setValue(ObjectRef objectRef, Object source, Object value, FieldContext context)
| | public void | setValueForEach(Collection collection, Object value, FieldContext context, Object eventSource)
Sets each object in a collection to value. | | public void | setVector(boolean vector)
| | public void | setWork(boolean work)
| | public void | setZeroBasedIndex(boolean zeroBasedIndex)
| | public String | syntaxErrorForField()
| | public String | toExternalText(Object value, Object obj)
| | public String | toString()
| | public String | typeName()
Return the name in shortned form: e.g. | | public static Object | value(Field field, Node node, NodeModel nodeModel)
| | public static Object | value(Field field, Object object)
|
| MULTIPLE_VALUES | | final public static String MULTIPLE_VALUES(Code) | | |
| NOT_APPLICABLE | | final public static String NOT_APPLICABLE(Code) | | |
| dateOnly | | boolean dateOnly(Code) | | |
| Field | | public Field()(Code) | | Fields are constructed using chained properties
|
| build | | public boolean build()(Code) | | |
| clearFormula | | public void clearFormula()(Code) | | |
| compare | | public int compare(Object arg0, Object arg1)(Code) | | Compare two objects using this field. In this way i
|
| compareTo | | public int compareTo(Object to)(Code) | | Compares two fields. Normally a simple String compareTo is used, but in
the case of array fields, I compare their indexes - we want such fields
to sort numerically and not alphabetically so that for example, Cost11
appears after Cost2 and not before.
|
| convertValueToStringUsingOptions | | public String convertValueToStringUsingOptions(Object value)(Code) | | |
| copyData | | public void copyData(Object to, Object from)(Code) | | Copies field data from one object to another. Does not copy read only
fields
Parameters:
to -
Parameters:
from - |
| copyData | | public static void copyData(Collection fieldArray, Object to, Object from)(Code) | | Copies multiple fields from one object to another
Parameters:
fieldArray -
Parameters:
to -
Parameters:
from - |
| copyData | | public static void copyData(Object to, Map fromMap) throws FieldParseException(Code) | | Copies data from a map which contains Field Ids (e.g. Field.work) as keys
and values (either string or object) to the destination to. Read Only
fields are ignored.
Parameters:
to -
Parameters:
fromMap -
throws:
FieldParseException - |
| copyData | | public static void copyData(Map toMap, Object from, Collection fieldArray)(Code) | | Copies a set of fields, defined by the fieldArray to a map with their
values
Parameters:
toMap -
Parameters:
from -
Parameters:
fieldArray - |
| createIndexedField | | public Field createIndexedField(int index)(Code) | | |
| createIntervalField | | public static Field createIntervalField(Field f, Interval interval)(Code) | | Make a new field with an integrated context that uses the given interval
Parameters:
f -
Parameters:
interval - |
| getColumnWidth | | public int getColumnWidth()(Code) | | Returns the . |
| getColumnWidth | | public int getColumnWidth(boolean svg)(Code) | | |
| getCommonValue | | public Object getCommonValue(Collection collection, boolean useMultipleValue, boolean text)(Code) | | Given a collection, if each elements shares the same value for this
field, the value is returned, Otherwise null is returned.
Parameters:
collection -
Parameters:
useMultipleValue - If true, the default value will be used if no elements orvalues differ |
| getCommonValueString | | public String getCommonValueString(Collection collection)(Code) | | Given a collection, return the text for a field if each elements shares
the same value, otherwise return "--"
Parameters:
collection - |
| getDefaultValue | | public Object getDefaultValue()(Code) | | Returns the defaultValue. |
| getDisplayType | | public Class getDisplayType()(Code) | | Returns the type to use for this field in spreadsheets anddialogs. |
| getExtraCategory | | final public String getExtraCategory()(Code) | | |
| getGroupSummary | | public int getGroupSummary()(Code) | | |
| getHorizontalAlignment | | public int getHorizontalAlignment()(Code) | | |
| getIndex | | public int getIndex()(Code) | | Returns the index. |
| getIndexes | | public int getIndexes()(Code) | | Returns the indexes. |
| getMetadataStringHeader | | public static String getMetadataStringHeader()(Code) | | |
| getMultipleValueForType | | public Object getMultipleValueForType()(Code) | | |
| getOptions | | public Object[] getOptions(Object object)(Code) | | For use in populating a list box
Parameters:
object - TODO |
| getProperty | | public String getProperty()(Code) | | Returns the property. |
| getReferencedIdProperty | | public String getReferencedIdProperty()(Code) | | Returns the referencedIdProperty. |
| getReferencedObjectProperty | | public String getReferencedObjectProperty()(Code) | | Returns the referencedObjectProperty. |
| getScaleFactor | | public double getScaleFactor()(Code) | | |
| getSelect | | public Select getSelect()(Code) | | Returns the select. |
| getSummary | | public int getSummary()(Code) | | |
| getSummaryForGroup | | public int getSummaryForGroup()(Code) | | |
| getSvgColumnWidth | | public int getSvgColumnWidth()(Code) | | |
| getTextWidth | | public int getTextWidth()(Code) | | |
| hasDynamicSelect | | public boolean hasDynamicSelect()(Code) | | |
| hasFilter | | public boolean hasFilter()(Code) | | |
| hasOptions | | public boolean hasOptions()(Code) | | |
| hasSummary | | public boolean hasSummary()(Code) | | |
| isApplicable | | public boolean isApplicable(Object object)(Code) | | To see if the field applies to the object, see if the field's type is a
supertype or same as object
Parameters:
object - |
| isApplicable | | public boolean isApplicable(Class type)(Code) | | |
| isApplicable | | public boolean isApplicable(Class[] types)(Code) | | Is field applicable to any type in types array
Parameters:
types - |
| isAuthorized | | public boolean isAuthorized(int role)(Code) | | |
| isBoolean | | public boolean isBoolean()(Code) | | |
| isCallValidateOnClear | | public boolean isCallValidateOnClear()(Code) | | Returns the callValidateOnClear. |
| isCantReset | | public boolean isCantReset()(Code) | | Returns the cantReset. |
| isComparable | | public boolean isComparable()(Code) | | |
| isCustom | | public boolean isCustom()(Code) | | |
| isDate | | public boolean isDate()(Code) | | Returns the date. |
| isDateOnly | | public boolean isDateOnly()(Code) | | |
| isDirtiesWholeDocument | | final public boolean isDirtiesWholeDocument()(Code) | | |
| isDontLimitToChoices | | public boolean isDontLimitToChoices()(Code) | | Returns the dontLimitToChoices. |
| isDuration | | public boolean isDuration()(Code) | | Returns the duration. |
| isDurationOrWork | | public boolean isDurationOrWork()(Code) | | |
| isDynamicOptions | | final public boolean isDynamicOptions()(Code) | | |
| isEndValue | | public boolean isEndValue()(Code) | | |
| isExtra | | public boolean isExtra()(Code) | | |
| isFormula | | public boolean isFormula()(Code) | | Returns the formula. |
| isGraphical | | public boolean isGraphical()(Code) | | |
| isHasFilter | | public boolean isHasFilter()(Code) | | |
| isHasOptions | | public boolean isHasOptions()(Code) | | |
| isHasToolTip | | final public boolean isHasToolTip()(Code) | | |
| isHideZeroValues | | public boolean isHideZeroValues()(Code) | | Returns the hideZeroValues. |
| isHyperlink | | final public boolean isHyperlink()(Code) | | |
| isImage | | final public boolean isImage()(Code) | | |
| isIndexed | | public boolean isIndexed()(Code) | | |
| isLink | | public boolean isLink()(Code) | | |
| isMap | | final public boolean isMap()(Code) | | |
| isMemo | | public boolean isMemo()(Code) | | Returns the memo. |
| isMoney | | public boolean isMoney()(Code) | | Returns the money. |
| isNameField | | public boolean isNameField()(Code) | | Returns the nameField. |
| isNumber | | public boolean isNumber()(Code) | | |
| isPassword | | public boolean isPassword()(Code) | | Returns the password. |
| isPercent | | public boolean isPercent()(Code) | | Returns the percent. |
| isRate | | public boolean isRate()(Code) | | Returns the value. |
| isReadOnly | | public boolean isReadOnly()(Code) | | Returns the readOnly. It's a static vlue |
| isReadOnly | | public boolean isReadOnly(Node node, WalkersNodeModel nodeModel, FieldContext context)(Code) | | See if a node is read only. Before calling the object-based version of
read-only, it checks to see if the node is a summarized parent and if the
field is a summarized value, thus read only
Parameters:
node -
Parameters:
nodeModel -
Parameters:
context - |
| isReadOnly | | public boolean isReadOnly(Object object, FieldContext context)(Code) | | See if the field is read only
Parameters:
object -
Parameters:
context - |
| isScalar | | public boolean isScalar()(Code) | | Returns the scalar. |
| isServer | | public boolean isServer()(Code) | | |
| isStandardType | | public boolean isStandardType()(Code) | | |
| isStartValue | | public boolean isStartValue()(Code) | | |
| isValidChoice | | public boolean isValidChoice(String textValue)(Code) | | |
| isValidOnObjectCreate | | final public boolean isValidOnObjectCreate()(Code) | | |
| isVector | | public boolean isVector()(Code) | | Returns the vector. |
| isWork | | public boolean isWork()(Code) | | Returns the work. |
| isZeroBasedIndex | | public boolean isZeroBasedIndex()(Code) | | Returns the zeroBasedIndex. |
| setBoundsField | | public void setBoundsField(String boundsField)(Code) | | Set the array size of the custom field this applies to
Parameters:
boundsField - |
| setCallValidateOnClear | | public void setCallValidateOnClear(boolean callValidateOnClear)(Code) | |
Parameters:
callValidateOnClear - The callValidateOnClear to set. |
| setCantReset | | public void setCantReset(boolean cantReset)(Code) | |
Parameters:
cantReset - The cantReset to set. |
| setColumnWidth | | public void setColumnWidth(int columnWidth)(Code) | |
Parameters:
columnWidth - The columnWidth to set. |
| setCustom | | public void setCustom(boolean custom)(Code) | | |
| setDate | | public void setDate(boolean date)(Code) | |
Parameters:
date - The date to set. |
| setDateOnly | | public void setDateOnly(boolean dateOnly)(Code) | | |
| setDefaultValue | | public void setDefaultValue(Object defaultValue)(Code) | |
Parameters:
defaultValue - The defaultValue to set. |
| setDirtiesWholeDocument | | final public void setDirtiesWholeDocument(boolean dirtiesWholeDocument)(Code) | | |
| setDontLimitToChoices | | public void setDontLimitToChoices(boolean dontLimitToChoices)(Code) | |
Parameters:
dontLimitToChoices - The dontLimitToChoices to set. |
| setDuration | | public void setDuration(boolean duration)(Code) | |
Parameters:
duration - The duration to set. |
| setDynamicOptions | | final public void setDynamicOptions(boolean dynamicOptions)(Code) | | |
| setEndValue | | public void setEndValue(boolean endValue)(Code) | | |
| setEnglishName | | final public void setEnglishName(String englishName)(Code) | | |
| setErrorMessage | | final public void setErrorMessage(String errorMessage)(Code) | | |
| setExternalType | | final public void setExternalType(Class externalType)(Code) | | |
| setExtraCategory | | final public void setExtraCategory(String extraCategory)(Code) | | |
| setFormula | | public void setFormula(String formulaName, String variableName, String formulaText)(Code) | |
Parameters:
formula - The formula to set. |
| setGraphical | | public void setGraphical(boolean graphical)(Code) | | |
| setGroupSum | | final public void setGroupSum(String summaryType)(Code) | | |
| setHasToolTip | | final public void setHasToolTip(boolean hasToolTip)(Code) | | |
| setHideZeroValues | | public void setHideZeroValues(boolean hideZeroValues)(Code) | |
Parameters:
hideZeroValues - The hideZeroValues to set. |
| setId | | public void setId(String id)(Code) | |
Parameters:
id - The id to set. |
| setImage | | final public void setImage(boolean image)(Code) | | |
| setIndex | | public void setIndex(int index)(Code) | |
Parameters:
index - The index to set. |
| setIndexes | | public void setIndexes(int indexes)(Code) | |
Parameters:
indexes - The indexes to set. |
| setLookupTypes | | public void setLookupTypes(String lookupTypes)(Code) | | |
| setMemo | | public void setMemo(boolean memo)(Code) | |
Parameters:
memo - The memo to set. |
| setMoney | | public void setMoney(boolean money)(Code) | |
Parameters:
money - The money to set. |
| setNameField | | public void setNameField(boolean nameField)(Code) | |
Parameters:
nameField - The nameField to set. |
| setPassword | | public void setPassword(boolean password)(Code) | |
Parameters:
password - The password to set. |
| setPercent | | public void setPercent(boolean percent)(Code) | |
Parameters:
percent - The percent to set. |
| setProperty | | final public void setProperty(String property)(Code) | | |
| setRange | | public void setRange(Range range)(Code) | |
Parameters:
range - The range to set. |
| setRate | | public void setRate(boolean rate)(Code) | |
Parameters:
value - The value to set. |
| setReadOnly | | public void setReadOnly(boolean readOnly)(Code) | |
Parameters:
readOnly - The readOnly to set. |
| setReferencedIdProperty | | public void setReferencedIdProperty(String referencedIdProperty)(Code) | |
Parameters:
referencedIdProperty - The referencedIdProperty to set. |
| setReferencedObjectProperty | | public void setReferencedObjectProperty(String referencedObjectProperty)(Code) | |
Parameters:
referencedObjectProperty - The referencedObjectProperty to set. |
| setScalar | | public void setScalar(boolean scalar)(Code) | |
Parameters:
scalar - The scalar to set. |
| setServer | | public void setServer(boolean server)(Code) | | |
| setSpecialFieldContext | | public void setSpecialFieldContext(FieldContext specialFieldContext)(Code) | | |
| setStartValue | | public void setStartValue(boolean startValue)(Code) | | |
| setSummary | | final public void setSummary(String summaryType)(Code) | | |
| setSvgColumnWidth | | public void setSvgColumnWidth(int svgColumnWidth)(Code) | | |
| setTextWidth | | final public void setTextWidth(int textWidth)(Code) | | |
| setValidOnObjectCreate | | final public void setValidOnObjectCreate(boolean validOnObjectCreate)(Code) | | |
| setValueForEach | | public void setValueForEach(Collection collection, Object value, FieldContext context, Object eventSource)(Code) | | Sets each object in a collection to value. Exceptions are ignored
Parameters:
collection -
Parameters:
value - |
| setVector | | public void setVector(boolean vector)(Code) | |
Parameters:
vector - The vector to set. |
| setWork | | public void setWork(boolean work)(Code) | |
Parameters:
work - The work to set. |
| setZeroBasedIndex | | public void setZeroBasedIndex(boolean zeroBasedIndex)(Code) | |
Parameters:
zeroBasedIndex - The zeroBasedIndex to set. |
| syntaxErrorForField | | public String syntaxErrorForField()(Code) | | |
| typeName | | public String typeName()(Code) | | Return the name in shortned form: e.g. Long, String, etc.
|
|
|