com.dynamide
Class Field

java.lang.Object
  extended by com.dynamide.DynamideObject
      extended by com.dynamide.resource.ContextNode
          extended by com.dynamide.JDOMFile
              extended by com.dynamide.Persistent
                  extended by com.dynamide.Field
All Implemented Interfaces:
IPropertyProvider, IContext, IGet, org.xml.sax.EntityResolver

public class Field
extends Persistent


Nested Class Summary
 
Nested classes/interfaces inherited from class com.dynamide.Persistent
Persistent.Source
 
Field Summary
 java.lang.Object id
           
 
Fields inherited from class com.dynamide.Persistent
DEBUG_PAGE_SAVE, DEBUG_PROPS
 
Fields inherited from class com.dynamide.DynamideObject
m_id
 
Constructor Summary
Field(DynamideObject owner, Session session)
           
Field(DynamideObject owner, Session session, org.jdom.Element fieldElement, java.lang.String ownerID)
           
Field(DynamideObject owner, Session session, java.lang.String name, java.lang.Object value)
           
 
Method Summary
 void clear()
           
 void clearError()
           
 java.lang.String dump()
          Subclasses can override this with something more descriptive, for logging and debugging.
 boolean equals(java.lang.Object other)
          This is implemented to simply compare the String value of the "value" attribute and nothing else, which makes it possible to compare this field to a string value in WebMacro.
static java.lang.String formatFullFieldName(java.lang.String datasource, java.lang.String fieldName, java.lang.String fieldIndex)
           
 java.lang.Object get(java.lang.String which)
          Subclasses can override this.
 boolean getEnabled()
           
 boolean getError()
           
 java.lang.String getErrorMessage()
           
 java.lang.String getID()
           
 java.lang.String getName()
           
 java.lang.String getStringValue()
           
 java.lang.Object getValue()
           
 java.lang.Object getValueObject(java.lang.String name)
           
 boolean isValueTrue(java.lang.String propertyName)
          Same as isPropertyTrue
 void set(java.lang.String name, java.lang.Object value)
           
 void setEnabled(boolean new_value)
           
 void setError(boolean newError)
           
 void setErrorMessage(java.lang.String message)
           
 void setValue(java.lang.Object value)
           
 java.lang.String toString()
           
 void uncaughtSet(java.lang.String name, java.lang.Object value)
           
 
Methods inherited from class com.dynamide.Persistent
addProperties, addProperty, clonePropertiesTable, dumpHTML, dumpProperties, findEventElement, getEvents, getEventSignature, getEventSource, getEventSource, getEventSourceBody, getHtmlsrcElement, getHtmlsrcElement, getNamedObject, getProperties, getPropertiesElement, getPropertiesTable, getProperty, getPropertyNames, getPropertyStringValue, getPropertyValue, getRawHTMLSource, getRawHTMLSource, getSession, getSourceElement, getSourceElement, hasProperty, isPropertyTrue, listEvents, listEventsHTML, listProperties, mergeProperties, mergeProperty, removeProperty, removeWidgetContents, removeWidgetContents, resetPropertiesTable, setEventSource, setHTMLSource, setHTMLSourceIE, setNamedObject, setProperty, setProperty, setProperty, setPropertyValue, setSession, sortPropertiesTable
 
Methods inherited from class com.dynamide.JDOMFile
addError, clearErrors, commitInMemoryChangesToDOM, createJDomXMLOutputter, findFirstElement, findFirstElement, findFirstElementWithAttribute, getAttributeValue, getDocument, getErrors, getFilename, getFullXMLSource, getRootElement, hideEntities, isValidXHTML, isValidXHTMLFragment, listNamedElement, main, output, output, output, output, output, prepare, prettyPrintHTML, prettyPrintHTML, prettyPrintHTMLSafe, read, readFromString, reload, resolveEntity, safeGetElementChildText, saveToFile, saveToFile, select, select, select, selectFirst, selectFirst, setFilename, testPrettyPrint, unHideEntities, valueOf, valueOf
 
Methods inherited from class com.dynamide.resource.ContextNode
bind, bind, bindAll, bindAllAttributes, bindAttribute, dumpAttributes, dumpContext, find, find, find, firstContext, getAttribute, getAttributeCount, getAttributes, getContext, getContextCount, getContexts, getKey, getPermission, hasAttribute, hasContext, listAttributeNames, listAttributeNames, listContextNames, listContextNames, lockPermissions, rebind, rebind, rebindAttribute, remove, removeAttribute, removeFirstContext, setKey, unlockPermissions, update, writeCache
 
Methods inherited from class com.dynamide.DynamideObject
clearProfiler, dump, expand, finalize, findParentExpander, findParentPage, findParentSession, findTopParentPage, getCategoryID, getDotName, getNextGetter, getObjectID, getOwner, getProfiler, isDebugEnabled, isInfoEnabled, logDebug, logDebug, logDebug, logDebug, logError, logError, logError, logError, logInfo, logInfo, logInfo, logInfo, logWarn, logWarn, logWarn, logWarn, popLogContext, printf, printProfiler, profileEnter, profileLeave, pushLogContext, setDotName, setID, setNextGetter, setObjectID, setOwner, sprintf, useProfiler, walkParents
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

id

public java.lang.Object id
Constructor Detail

Field

public Field(DynamideObject owner,
             Session session)

Field

public Field(DynamideObject owner,
             Session session,
             java.lang.String name,
             java.lang.Object value)
      throws DatatypeException
Throws:
DatatypeException

Field

public Field(DynamideObject owner,
             Session session,
             org.jdom.Element fieldElement,
             java.lang.String ownerID)
      throws org.jdom.JDOMException,
             DatatypeException
Throws:
org.jdom.JDOMException
DatatypeException
Method Detail

formatFullFieldName

public static java.lang.String formatFullFieldName(java.lang.String datasource,
                                                   java.lang.String fieldName,
                                                   java.lang.String fieldIndex)

getName

public java.lang.String getName()

getID

public java.lang.String getID()
Overrides:
getID in class DynamideObject

get

public java.lang.Object get(java.lang.String which)
Description copied from class: DynamideObject
Subclasses can override this.

Specified by:
get in interface IGet
Overrides:
get in class ContextNode

getValue

public java.lang.Object getValue()

getValueObject

public java.lang.Object getValueObject(java.lang.String name)

clear

public void clear()

setValue

public void setValue(java.lang.Object value)

set

public void set(java.lang.String name,
                java.lang.Object value)

uncaughtSet

public void uncaughtSet(java.lang.String name,
                        java.lang.Object value)
                 throws DatatypeException
Throws:
DatatypeException

isValueTrue

public boolean isValueTrue(java.lang.String propertyName)
Description copied from class: Persistent
Same as isPropertyTrue

Overrides:
isValueTrue in class Persistent

getStringValue

public java.lang.String getStringValue()

getEnabled

public boolean getEnabled()

setEnabled

public void setEnabled(boolean new_value)

getError

public boolean getError()

setError

public void setError(boolean newError)

getErrorMessage

public java.lang.String getErrorMessage()

setErrorMessage

public void setErrorMessage(java.lang.String message)

clearError

public void clearError()

toString

public java.lang.String toString()
Overrides:
toString in class Persistent

equals

public boolean equals(java.lang.Object other)
This is implemented to simply compare the String value of the "value" attribute and nothing else, which makes it possible to compare this field to a string value in WebMacro. Any other comparison will not be very good, as two Field objects are not checked for true identity.

Overrides:
equals in class java.lang.Object

dump

public java.lang.String dump()
Description copied from class: DynamideObject
Subclasses can override this with something more descriptive, for logging and debugging.

Overrides:
dump in class ContextNode


Copyright 2001-2013 DYNAMIDE.COM. All Rights Reserved.