public class RecordGroupColumn extends BaseFormsObject
In some cases, using methods on this class may result in a
JdapiIllegalStateException being thrown. When this happens, you are using
an object that refers to a Forms object that has been deleted - your
reference is no longer valid. You can check if an instance of this
class is valid by using the isValidFormsObject()
method.
If you code correctly, this should not happen. It will tend to happen
if you keep references (for extended periods) to Forms objects rather
than look them up dynamically. Of course you will only have this
problem if you destroy Forms objects.
BaseAPI
m_clientInfo, m_pd2fob
PROPERTY_DEFAULT_VALUE, PROPERTY_INHERITED_VALUE, PROPERTY_OVERRIDDEN_DEFAULT_VALUE, PROPERTY_OVERRIDDEN_INHERITED_VALUE, PROPERTY_STATE_UNKNOWN
Modifier | Constructor and Description |
---|---|
protected |
RecordGroupColumn(long pd2frcs)
Protected constructor, used internally to create RecordGroupColumn
objects.
|
|
RecordGroupColumn(RecordGroup parent,
java.lang.String name)
Constructor used to create RecordGroupColumn objects in the context of
a RecordGroup parent object.
|
|
RecordGroupColumn(RecordGroup parent,
java.lang.String name,
PropertyClass base)
Constructor used to create RecordGroupColumn objects in the context of a
RecordGroup parent object.
|
|
RecordGroupColumn(RecordGroup parent,
java.lang.String name,
RecordGroupColumn base)
Constructor used to create RecordGroupColumn objects in the context of a
RecordGroup parent object.
|
Modifier and Type | Method and Description |
---|---|
RecordGroupColumn |
clone(RecordGroup parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
void |
deleteRow(int index)
Deletes a row from the record group column.
|
static RecordGroupColumn |
find(RecordGroup parent,
java.lang.String name)
Find an instance of RecordGroupColumn that is a child of a RecordGroup.
|
int |
getColumnDataType()
Get number property ColumnDataType (COLUMN_DATA_TYPE_PTID).
|
int |
getColumnValuesCount()
Get number property ColumnValuesCount (COLUMN_VALUES_COUNT_PTID).
|
int |
getDataLengthSemantics()
Get number property DataLengthSemantics (DATA_LENGTH_SEMANTICS_PTID).
|
int |
getMaximumLength()
Get number property MaximumLength (MAXIMUM_LENGTH_PTID).
|
java.lang.String |
getName()
Get text property Name (NAME_PTID).
|
int |
getPersistentClientInfoLength()
Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
|
java.lang.String |
getRow(int index)
Gets a row from the record group column.
|
java.lang.String |
getRowName(int index)
Gets a row's name from the record group column (used by XLIFF utility)
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
void |
insertFormattedRow(int index,
java.lang.String text,
java.lang.String fmtMask)
Insert a row into the record group column.
|
void |
insertRow(int index,
java.lang.String text)
Insert a row into the record group column.
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
void |
setColumnDataType(int value)
Sets number property ColumnDataType (COLUMN_DATA_TYPE_PTID).
|
void |
setDataLengthSemantics(int value)
Sets number property DataLengthSemantics (DATA_LENGTH_SEMANTICS_PTID).
|
void |
setDirtyInfo(boolean value)
Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
|
void |
setMaximumLength(int value)
Sets number property MaximumLength (MAXIMUM_LENGTH_PTID).
|
void |
setName(java.lang.String value)
Sets text property Name (NAME_PTID).
|
void |
setPersistentClientInfoLength(int value)
Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
|
changeOwner, clearObjectPointer, clone, createSubclassedChild, destroy, equals, getBooleanProperty, getChildObjectProperty, getClassName, getClientInfo, getIntegerProperty, getIntegerPropertyString, getJdapiMetaObject, getMetaProperties, getModule, getObjectPointer, getObjectProperty, getObjProp, getOwnedObjects, getOwner, getPersistentClientInfoBlob, getPersistentClientInfoObject, getPropertyState, getPropertyValueName, getQualifiedName, getStringIDProperty, getStringProperty, getSubclassParent, hasDefaultedProperty, hasInheritedProperty, hasOverriddenProperty, hasProperty, inheritProperty, isSubclassed, isValidFormsObject, move, queryType, reattach, setBooleanProperty, setClientInfo, setIntegerProperty, setObjectProperty, setObjProp, setPersistentClientInfo, setPersistentClientInfo, setStringProperty, setSubclassParent, toString, unsetSubclassParent
public RecordGroupColumn(RecordGroup parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic RecordGroupColumn(RecordGroup parent, java.lang.String name, RecordGroupColumn base)
parent
- Parent objectname
- Name of the new objectbase
- RecordGroupColumn object to derive frompublic RecordGroupColumn(RecordGroup parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive fromprotected RecordGroupColumn(long pd2frcs)
Do NOT use this constructor, even within the Jdapi package. If you have a pointer and need to instantiate it's Java representation, get the object via the context cache, e.g.
myBaseObject = Jdapi.getObject(myPointer);
pd2frcs
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public RecordGroupColumn clone(RecordGroup parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static RecordGroupColumn find(RecordGroup parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic void insertRow(int index, java.lang.String text)
index
- Index to insert row attext
- Entry to insertpublic void insertFormattedRow(int index, java.lang.String text, java.lang.String fmtMask)
index
- Index to insert row attext
- Entry to insertfmtMask
- Format mask to usepublic void deleteRow(int index)
index
- Index of row to deletepublic java.lang.String getRow(int index)
index
- Index of row to getpublic java.lang.String getRowName(int index)
index
- Index of row to getpublic java.lang.String getName()
getName
in interface JdapiObject
getName
in class BaseFormsObject
public void setName(java.lang.String value)
value
- Value to set property topublic int getColumnDataType()
public void setColumnDataType(int value)
value
- Value to set property topublic int getColumnValuesCount()
public int getDataLengthSemantics()
public void setDataLengthSemantics(int value)
value
- Value to set property topublic int getMaximumLength()
public void setMaximumLength(int value)
value
- Value to set property topublic int getPersistentClientInfoLength()
public void setPersistentClientInfoLength(int value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property to