planetj.dataengine.theme
Class Theme

java.lang.Object
  planetj.database.Row
      planetj.dataengine.PropertyRow
          planetj.dataengine.theme.Theme

All Implemented Interfaces:

java.lang.Cloneable, IActionObject, IBatchProcessObject, IBusinessObject, ICSVRow, IFDFObject, IGuarded, INamedCollection, INavigationObject, IOwner, IRowCreator, ITheme, IXMLObject, java.io.Serializable

public class Theme

extends PropertyRow

implements java.io.Serializable, ITheme, IOwner

Contains information describing a DataEngine theme

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.database.Row

Row.SpacingRow

Field Summary

static java.lang.String

className Class name

Fields inherited from class planetj.database.Row

DISPLAY_ORDER_COMPARATOR, MODE_ALTER, MODE_COPY, MODE_DELETE, MODE_INSERT, MODE_READ, MODE_SEARCH, MODE_UNKNOWN, MODE_UPDATE, mRowEventListeners

Fields inherited from interface planetj.dataengine.theme.ITheme

CSS_FILE, DEFAULT_THEME_ID, DESCRIPTION, OWNER_ID, PROPERTIES, SECURITY_ID, THEME, THEME_ID, TYPE, TYPE_DEFAULT

Fields inherited from interface planetj.dataengine.security.IGuarded

TYPE_ID_UNKNOWN, TYPE_NAME_FIELD, TYPE_NAME_SQLOPERATION, TYPE_SECURED_BY_LEVEL, TYPE_SECURED_BY_OPERATION, TYPE_UNSECURED

Constructor Summary

Theme()

Method Summary

java.lang.String	getCSSFile() Gets this Theme's CSS file.
java.lang.String	getDescription() Gets the description for this Theme.
java.lang.Object	getFieldDefaultValue(Field field, ExecutingContext executingContext) Get the field's default value as a String.
int	getId() Gets the ID of this Theme
java.lang.Integer	getIdAsInteger() Gets the ID of this Theme.
LayoutDisplayPropertyGroup	getLayoutProperties() Gets this themes layout properties
int	getOwnerId() Gets the ID of this Theme's owner.
java.lang.Integer	getOwnerIdAsInteger() Gets the ID of this Theme's owner
Field	getOwnerIdField() Returns the Owner Id Field
java.lang.String	getProperties() Gets the property string associated with this Theme.
java.lang.String	getPropertyFieldName() Get the name of the Field containing this Row's properties..
int	getSecurityId() Gets the ID of this Theme's security.
java.lang.Integer	getSecurityIdAsInteger() Gets the ID of this Theme's security.
PropertyGroupList	getThemePropertyGroups() Deprecated. replaced with getRowPropertyGroups()
java.lang.String	getTranslatedDescription(UserProperties up) Gets the translated description of this Theme.
int	getType() Gets the type of this Theme.
void	setCSSFile(java.lang.String cssFile) Sets this Theme's CSS file.
void	setDescription(java.lang.String value) Sets the description for this Theme.
void	setId(int value) Sets the ID of this Theme.
void	setId(java.lang.Integer value) Sets the ID of this Theme.
void	setOwnerId(int value) Sets the ID of this Theme's owner
void	setOwnerId(java.lang.Integer value) Sets the ID of this Theme's owner
void	setProperties(java.lang.String properties) Sets the property string associated with this Theme.
void	setSecurityId(int value) Sets the ID of this Theme's security
void	setSecurityId(java.lang.Integer value) Sets the ID of this Theme's security
protected void	setThemePropertyGroups(PropertyGroupList pPropertyGroups) Deprecated. replaced with setRowPropertyGroups(PropertyGroupList)
void	setType(int value) Sets this Theme's type.

Methods inherited from class planetj.dataengine.PropertyRow

createRow, getRowPropertyGroup, getRowPropertyGroups, getRowPropertyGroups, insert, setPropertiesInternal, setRowPropertyGroups, setRowPropertyGroupsInternal, transferDataTo, transferPropertiesTo, update

Methods inherited from class planetj.database.Row

add, add, addObject, addPropertyChangeListener, addPropertyChangeListener, addRowEventListener, addRowEventListeners, addTable, addToRowCollection, appendDisplayType, batchProcess, clearFields, clearTables, clearValidationException, clone, cloneRow, commitFieldValues, commitFieldValues, commitFieldValues, concatenateFieldFullLengthValues, concatenateFieldValues, containsField, copy, copyIntoRowFieldsWithCommonFieldNames, copyIntoRowFieldsWithCommonFieldNames, copyIntoRowFieldsWithCommonUsageIds, copyIntoRowFieldsWithGivenFieldNames, copyIntoRowFieldsWithGivenFieldNames, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, create, createAction, createNamedActionRequest, createSQLContextForDelete, createSQLContextForInsert, createSQLContextForUpdate, dataTransferred, defaultMerge, delete, delete, delete, delete, deleteObject, divide, duplicateKey, duplicateKey, enforceExclusiveOr, equals, equals, equalsInstance, fieldHasPossibleValuesSQLOperation, firePropertyChange, fireRowEvent, getActionDefaultLocation, getActionDescriptor, getActionRequest, getActionRequest, getActions, getActionsForFields, getActionsForOperation, getAssociation, getAssociation, getAssociationByOperationUsageId, getAssociationOperation, getAttribute, getAutoIncrementDatabaseDrivenField, getBackgroundColor, getChangedFields, getChildren, getColumnSpan, getCompleteRow, getCompleteRow, getConcurrentFields, getConfigProperty, getCopiedFieldValues, getCreationContext, getCSVRow, getCSVRow, getDatabaseRow, getDatabaseRow, getDatabaseRow, getDatabaseRow, getDBSystem, getDeleteConfirmation, getDeleteConfirmationMessage, getDisjointRowClass, getDisplayValue, getDisplayValueByUsageId, getDisplayValueForKey, getErrorMessageForOperation, getExternalName, getExternalNames, getFDFData, getFDTable, getField, getField, getField, getFieldAssociationOperation, getFieldCollection, getFieldDescriptor, getFieldDescriptor, getFieldDescriptor, getFieldDescriptorsWithUsage, getFieldDescriptorsWithUsageId, getFieldDescriptorWithUsageId, getFieldDisplayComponent, getFieldDisplayOrder, getFieldDisplayValue, getFieldDisplayValue, getFieldExternalName, getFieldFieldClassParameters, getFieldFieldSetName, getFieldIncrementor, getFieldMaxLength, getFieldNames, getFieldNames, getFieldPossibleValues, getFields, getFields, getFieldSearchDefaultValue, getFieldSets, getFieldsForInsert, getFieldSQLObject, getFieldStatusChange, getFieldsToDisplay, getFieldsToDisplayStrict, getFieldsToDisplayStrict, getFieldStyleClass, getFieldsWithUsageId, getFieldUsageIds, getFieldValue, getFieldValueWithUsageId, getFieldWithUsageId, getHeaderText, getHorizontalAlignment, getJSPFor, getKeyFieldNames, getKeyFields, getKeyFields, getLibraryName, getMaxFieldLengths, getMaxFieldLengths, getMaxInsertRetries, getMetaDataSystemAlias, getNamed, getNamed, getNamesOfUpdatedFields, getNavigationKey, getNavigationListKey, getNextOperationToRun, getOperation, getOperation, getOperationFromDB, getOperationFromDBByUsage, getPercentage, getPhysicalFieldNames, getPossibleValueClass, getPossibleValueClass, getPossibleValues, getPossibleValuesKey, getPossibleValuesOperation, getPropertyChangeSupport, getPropertyGroup, getPropertyGroups, getPropertyGroups, getReplacementFieldsToDisplay, getReplacementFieldsToDisplay, getRequiredFields, getRow, getRowCollection, getRowDisplayAttributes, getRowDisplayAttributes, getRowHandledActionNames, getRowKey, getSecuredTypeId, getSecuredTypeName, getSecurityType, getSQL, getSQLContext, getStaticAttribute, getStaticAttributes, getSum, getSystemAlias, getTabbedOperation, getTable, getTable, getTableName, getTables, getTimestamp, getUpdatedFields, getUserMessageForOperation, getUserMessageForOperation, getUseWOWLibrary, getValidationExceptions, getValueAsBoolean, getValueAsByte, getValueAsDate, getValueAsDate, getValueAsDouble, getValueAsDouble, getValueAsFloat, getValueAsFullLengthString, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsNumber, getValueAsNumber, getValueAsShort, getValueAsString, getValueAsString, getValueAsStringByUsageId, getValueByUsageId, getValueForKey, getValues, getXMLData, getXMLData, getXMLHeaderData, goToNextOperation, handleAction, hasAssociationOperation, hasChildRows, hasMultipleStyleClasses, hasPossibleValuesKeyClassOrOp, hasPossibleValuesOperation, hasPropertyChangeListeners, incrementFieldValue, initializeRow, initializeRow, initializeRow, initializeRow, initializeRow, initializeRow, insert, insert, insert, is, isActionApplicable, isActionRepeatable, isARow, isARowCollection, isChanged, isChanged, isChangedRealTime, isChangedSinceLastCheck, isCloneNeeded, isContainsAllFields, isCopyable, isCurrent, isDeletable, isDistinctRow, isEditable, isEmpty, isFieldApplicable, isFieldAuthorizedForEdit, isFieldAuthorizedForRead, isFieldAutoIncrement, isFieldAutoIncrementDatabaseDriven, isFieldAutoIncrementWOWDriven, isFieldDisplayable, isFieldPresent, isFieldReadOnly, isFieldReadOnlyOnSearch, isFieldRequired, isFieldRequiredOnSearch, isFieldsChanged, isFieldUpdateable, isFieldValueNotBlank, isFieldValuePossibleValue, isFieldValuesDatabaseDefaults, isGenerateChildRows, isGroupByRow, isGuarded, isHasColumnNames, isInARowCollection, isIncrementorResetAfterMaxInsertRetries, isInitializeDerivedFieldEnabled, isInitializeDerivedFieldsEnabled, isJoinedRow, isKeyFieldsPresent, isLogicalRow, isMultipleDeleteEnabled, isParameterRow, isPersistent, isPhysicalRow, isPrepareFieldValue, isPropertyChangeEventsEnabled, isReturningFromPossibleValuesSearch, isRowDisplayable, isRowKeyed, isSelectable, isStatusChange, isToBeSelected, isUnionRow, isUpdateable, isUseRowForFieldSets, isValidateDerivedFields, isValidateRequired, isValidationRequiredForAutoPopulate, isViewable, iterator, joinedDatabaseAccessFailure, joinedDelete, joinedDelete, joinedInsert, joinedInsert, joinedUpdate, joinedUpdate, merge, newField, newField, newField, newField, openFor, persist, populate, populate, populate, populateFD, postCreate, postDelete, postExtract, postInsert, postInsert, postUpdate, postUpdate, preDelete, preInsert, prepareForDetails, prepareForParameters, prepareForResultsDisplay, prepareFromFieldNames, preUpdate, removeField, removeField, removeNavigationKey, removePropertyChangeListener, removePropertyChangeListener, removeRowEventListener, removeRowEventListeners, replaceField, replaceFields, replaceFieldValues, replaceNumbersWithNames, reread, rereadIfNeeded, resetDisplayValues, rollbackChanges, runSQLQuery, runSQLQuery, runSQLStatement, runSQLStatement, setAttribute, setAutoUpdateFieldValues, setCreationContext, setCreationOperation, setFieldInitialValue, setFieldValue, setFieldValue, setFieldValue, setFieldValue, setFieldValueAsString, setFieldValueAsString, setFieldValuesAsDate, setFieldValuesToDefault, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonFieldNames, setFieldValuesWithCommonUsageIds, setFieldValueToDefault, setMultipleDeleteEnabled, setNavigationKey, setParameterRow, setPersistent, setPropertyChangeEventsEnabled, setPropertyGroups, setReturningFromPossibleValuesSearch, setRowDisplayAttributes, setSavepoint, setSavepoint, setSavepoint, setStaticAttribute, setTables, setTables, setUseWOWLibrary, setValidateDerivedFields, setValidateRequired, setValues, size, splitAndSetFieldValues, statusChanged, swapFieldValues, toCSV, toDOC, toDOC, toFDF, toPDF, toPDF, toString, toUpperCase, toXML, transferDataTo, update, update, update, updateFieldValues, updateGlobalValues, updateObject, validate, validate, validate, validateField, validateRowOperation

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

className

public static final java.lang.String className

Class name

Constructor Detail

Theme

public Theme()

Method Detail

getCSSFile

public java.lang.String getCSSFile()

Gets this Theme's CSS file.

getDescription

public java.lang.String getDescription()

Gets the description for this Theme.

getFieldDefaultValue

public java.lang.Object getFieldDefaultValue(Field field,
                                             ExecutingContext executingContext)
                                      throws CMException

Description copied from class: Row

Get the field's default value as a String.

Overrides:

getFieldDefaultValue in class Row

Throws:

CMException

getId

public int getId()

Gets the ID of this Theme

getIdAsInteger

public java.lang.Integer getIdAsInteger()

Gets the ID of this Theme.

getLayoutProperties

public LayoutDisplayPropertyGroup getLayoutProperties()

Gets this themes layout properties

getOwnerId

public int getOwnerId()

Gets the ID of this Theme's owner.

getOwnerIdAsInteger

public java.lang.Integer getOwnerIdAsInteger()

Gets the ID of this Theme's owner

getOwnerIdField

public Field getOwnerIdField()

Returns the Owner Id Field

Specified by:

getOwnerIdField in interface IOwner

Returns:

planetj.database.Field

See Also:

IOwner

getProperties

public java.lang.String getProperties()

Gets the property string associated with this Theme.

Overrides:

getProperties in class PropertyRow

getPropertyFieldName

public java.lang.String getPropertyFieldName()

Get the name of the Field containing this Row's properties..

Specified by:

getPropertyFieldName in class PropertyRow

getSecurityId

public int getSecurityId()

Gets the ID of this Theme's security.

getSecurityIdAsInteger

public java.lang.Integer getSecurityIdAsInteger()

Gets the ID of this Theme's security.

getThemePropertyGroups

public PropertyGroupList getThemePropertyGroups()

Deprecated. replaced with getRowPropertyGroups()

Gets the property group objects associated with this Theme. Any changes made to the PropertyGroupList or the PropertyGroups contained in that list will not be persisted - use the setPropertyGroups() method to alter the list of PropertyGroups.

getTranslatedDescription

public java.lang.String getTranslatedDescription(UserProperties up)

Gets the translated description of this Theme.

getType

public int getType()

Gets the type of this Theme.

setCSSFile

public void setCSSFile(java.lang.String cssFile)
                throws CMException

Sets this Theme's CSS file.

Throws:

CMException

setDescription

public void setDescription(java.lang.String value)
                    throws CMException

Sets the description for this Theme.

Throws:

CMException

setId

public void setId(int value)
           throws CMException

Sets the ID of this Theme.

Throws:

CMException

setId

public void setId(java.lang.Integer value)
           throws CMException

Sets the ID of this Theme.

Throws:

CMException

setOwnerId

public void setOwnerId(int value)
                throws CMException

Sets the ID of this Theme's owner

Throws:

CMException

setOwnerId

public void setOwnerId(java.lang.Integer value)
                throws CMException

Sets the ID of this Theme's owner

Throws:

CMException

setProperties

public void setProperties(java.lang.String properties)
                   throws CMException

Sets the property string associated with this Theme.

Overrides:

setProperties in class PropertyRow

Throws:

CMException

setSecurityId

public void setSecurityId(int value)
                   throws CMException

Sets the ID of this Theme's security

Throws:

CMException

setSecurityId

public void setSecurityId(java.lang.Integer value)
                   throws CMException

Sets the ID of this Theme's security

Throws:

CMException

setThemePropertyGroups

protected void setThemePropertyGroups(PropertyGroupList pPropertyGroups)
                               throws CMException

Deprecated. replaced with setRowPropertyGroups(PropertyGroupList)

Sets the PropertyGroups associated with this Theme.

Throws:

CMException

setType

public void setType(int value)
             throws CMException

Sets this Theme's type.

Throws:

CMException