public class RadioButton 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 |
---|---|
|
RadioButton(Item parent,
java.lang.String name)
Constructor used to create RadioButton objects in the context of
a Item parent object.
|
|
RadioButton(Item parent,
java.lang.String name,
PropertyClass base)
Constructor used to create RadioButton objects in the context of a
Item parent object.
|
|
RadioButton(Item parent,
java.lang.String name,
RadioButton base)
Constructor used to create RadioButton objects in the context of a
Item parent object.
|
protected |
RadioButton(long pd2frdb)
Protected constructor, used internally to create RadioButton
objects.
|
|
RadioButton(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name)
Constructor used to create RadioButton objects in the context of
an ObjectLibraryTab parent object.
|
|
RadioButton(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
PropertyClass base)
Constructor used to create RadioButton objects in the context of an
ObjectLibraryTab parent object.
|
|
RadioButton(ObjectLibrary olb,
ObjectLibraryTab tab,
java.lang.String name,
RadioButton base)
Constructor used to create RadioButton objects in the context of an
ObjectLibraryTab parent object.
|
Modifier and Type | Method and Description |
---|---|
RadioButton |
clone(Item parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
RadioButton |
clone(ObjectLibraryTab parent,
java.lang.String newName)
Creates a copy of the object as a child of 'parent'
|
static RadioButton |
find(Item parent,
java.lang.String name)
Find an instance of RadioButton that is a child of a Item.
|
static RadioButton |
find(ObjectLibraryTab parent,
java.lang.String name)
Find an instance of RadioButton that is a child of a ObjectLibraryTab.
|
java.lang.String |
getAccessKey()
Get text property AccessKey (ACCESS_KEY_PTID).
|
java.lang.String |
getBackColor()
Get text property BackColor (BACK_COLOR_PTID).
|
java.lang.String |
getComment()
Get text property Comment (COMMENT_PTID).
|
int |
getDistanceBetweenRecords()
Get number property DistanceBetweenRecords (DISTANCE_BETWEEN_RECORDS_PTID).
|
java.lang.String |
getFillPattern()
Get text property FillPattern (FILL_PATTERN_PTID).
|
java.lang.String |
getFontName()
Get text property FontName (FONT_NAME_PTID).
|
int |
getFontSize()
Get number property FontSize (FONT_SIZE_PTID).
|
int |
getFontSpacing()
Get number property FontSpacing (FONT_SPACING_PTID).
|
int |
getFontStyle()
Get number property FontStyle (FONT_STYLE_PTID).
|
int |
getFontWeight()
Get number property FontWeight (FONT_WEIGHT_PTID).
|
java.lang.String |
getForegroundColor()
Get text property ForegroundColor (FOREGROUND_COLOR_PTID).
|
int |
getHeight()
Get number property Height (HEIGHT_PTID).
|
java.lang.String |
getLabel()
Get text property Label (LABEL_PTID).
|
JdapiObject |
getModule()
Get object property Module (MODULE_PTID).
|
java.lang.String |
getName()
Get text property Name (NAME_PTID).
|
JdapiObject |
getOwner()
Get object property Owner (OWNER_PTID).
|
java.lang.String |
getParentFilename()
Get text property ParentFilename (PARENT_FILENAME_PTID).
|
java.lang.String |
getParentFilepath()
Get text property ParentFilepath (PARENT_FILEPATH_PTID).
|
java.lang.String |
getParentModule()
Get text property ParentModule (PARENT_MODULE_PTID).
|
int |
getParentModuleType()
Get number property ParentModuleType (PARENT_MODULETYPE_PTID).
|
java.lang.String |
getParentName()
Get text property ParentName (PARENT_NAME_PTID).
|
java.lang.String |
getParentSourceLevel1ObjectName()
Get text property ParentSourceLevel1ObjectName (PARENT_SOURCELEVEL1OBJECT_NAME_PTID).
|
int |
getParentSourceLevel1ObjectType()
Get number property ParentSourceLevel1ObjectType (PARENT_SOURCELEVEL1OBJECT_TYPE_PTID).
|
java.lang.String |
getParentSourceLevel2ObjectName()
Get text property ParentSourceLevel2ObjectName (PARENT_SOURCELEVEL2OBJECT_NAME_PTID).
|
int |
getParentSourceLevel2ObjectType()
Get number property ParentSourceLevel2ObjectType (PARENT_SOURCELEVEL2OBJECT_TYPE_PTID).
|
int |
getParentType()
Get number property ParentType (PARENT_TYPE_PTID).
|
int |
getPersistentClientInfoLength()
Get number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
|
java.lang.String |
getPrompt()
Get text property Prompt (PROMPT_PTID).
|
int |
getPromptAlign()
Get number property PromptAlign (PROMPT_ALIGN_PTID).
|
int |
getPromptAlignOffset()
Get number property PromptAlignOffset (PROMPT_ALIGN_OFFSET_PTID).
|
int |
getPromptAttachmentEdge()
Get number property PromptAttachmentEdge (PROMPT_ATTACHMENT_EDGE_PTID).
|
int |
getPromptAttachmentOffset()
Get number property PromptAttachmentOffset (PROMPT_ATTACHMENT_OFFSET_PTID).
|
java.lang.String |
getPromptBackColor()
Get text property PromptBackColor (PROMPT_BACK_COLOR_PTID).
|
int |
getPromptDisplayStyle()
Get number property PromptDisplayStyle (PROMPT_DISPLAY_STYLE_PTID).
|
java.lang.String |
getPromptFillPattern()
Get text property PromptFillPattern (PROMPT_FILL_PATTERN_PTID).
|
java.lang.String |
getPromptFontName()
Get text property PromptFontName (PROMPT_FONT_NAME_PTID).
|
int |
getPromptFontSize()
Get number property PromptFontSize (PROMPT_FONT_SIZE_PTID).
|
int |
getPromptFontSpacing()
Get number property PromptFontSpacing (PROMPT_FONT_SPACING_PTID).
|
int |
getPromptFontStyle()
Get number property PromptFontStyle (PROMPT_FONT_STYLE_PTID).
|
int |
getPromptFontWeight()
Get number property PromptFontWeight (PROMPT_FONT_WEIGHT_PTID).
|
java.lang.String |
getPromptForegroundColor()
Get text property PromptForegroundColor (PROMPT_FOREGROUND_COLOR_PTID).
|
int |
getPromptJustification()
Get number property PromptJustification (PROMPT_JUSTIFICATION_PTID).
|
int |
getPromptReadingOrder()
Get number property PromptReadingOrder (PROMPT_READING_ORDER_PTID).
|
java.lang.String |
getPromptVisualAttributeName()
Get text property PromptVisualAttributeName (PROMPT_VISUALATTRIBUTE_NAME_PTID).
|
VisualAttribute |
getPromptVisualAttributeObject()
Get object property PromptVisualAttributeObject (PROMPT_VISUALATTRIBUTE_OBJECT_PTID).
|
java.lang.String |
getRadioButtonValue()
Get text property RadioButtonValue (RADIOBUTTON_VALUE_PTID).
|
JdapiObject |
getSource()
Get object property Source (SOURCE_PTID).
|
int |
getTypeId()
Gets the HtmlForms object type ID.
|
java.lang.String |
getVisualAttributeName()
Get text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).
|
VisualAttribute |
getVisualAttributeObject()
Get object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).
|
int |
getWidth()
Get number property Width (WIDTH_PTID).
|
int |
getXPosition()
Get number property XPosition (X_POSITION_PTID).
|
int |
getYPosition()
Get number property YPosition (Y_POSITION_PTID).
|
boolean |
isDirtyInfo()
Get boolean property DirtyInfo (DIRTY_INFO_PTID).
|
boolean |
isEnabled()
Get boolean property Enabled (ENABLED_PTID).
|
boolean |
isSubclassSubObject()
Get boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
|
boolean |
isVisible()
Get boolean property Visible (VISIBLE_PTID).
|
void |
setAccessKey(java.lang.String value)
Sets text property AccessKey (ACCESS_KEY_PTID).
|
void |
setBackColor(java.lang.String value)
Sets text property BackColor (BACK_COLOR_PTID).
|
void |
setComment(java.lang.String value)
Sets text property Comment (COMMENT_PTID).
|
void |
setDirtyInfo(boolean value)
Sets boolean property DirtyInfo (DIRTY_INFO_PTID).
|
void |
setDistanceBetweenRecords(int value)
Sets number property DistanceBetweenRecords (DISTANCE_BETWEEN_RECORDS_PTID).
|
void |
setEnabled(boolean value)
Sets boolean property Enabled (ENABLED_PTID).
|
void |
setFillPattern(java.lang.String value)
Sets text property FillPattern (FILL_PATTERN_PTID).
|
void |
setFontName(java.lang.String value)
Sets text property FontName (FONT_NAME_PTID).
|
void |
setFontSize(int value)
Sets number property FontSize (FONT_SIZE_PTID).
|
void |
setFontSpacing(int value)
Sets number property FontSpacing (FONT_SPACING_PTID).
|
void |
setFontStyle(int value)
Sets number property FontStyle (FONT_STYLE_PTID).
|
void |
setFontWeight(int value)
Sets number property FontWeight (FONT_WEIGHT_PTID).
|
void |
setForegroundColor(java.lang.String value)
Sets text property ForegroundColor (FOREGROUND_COLOR_PTID).
|
void |
setHeight(int value)
Sets number property Height (HEIGHT_PTID).
|
void |
setLabel(java.lang.String value)
Sets text property Label (LABEL_PTID).
|
void |
setName(java.lang.String value)
Sets text property Name (NAME_PTID).
|
void |
setParentFilename(java.lang.String value)
Sets text property ParentFilename (PARENT_FILENAME_PTID).
|
void |
setParentFilepath(java.lang.String value)
Sets text property ParentFilepath (PARENT_FILEPATH_PTID).
|
void |
setParentModule(java.lang.String value)
Sets text property ParentModule (PARENT_MODULE_PTID).
|
void |
setParentModuleType(int value)
Sets number property ParentModuleType (PARENT_MODULETYPE_PTID).
|
void |
setParentName(java.lang.String value)
Sets text property ParentName (PARENT_NAME_PTID).
|
void |
setParentSourceLevel1ObjectName(java.lang.String value)
Sets text property ParentSourceLevel1ObjectName (PARENT_SOURCELEVEL1OBJECT_NAME_PTID).
|
void |
setParentSourceLevel1ObjectType(int value)
Sets number property ParentSourceLevel1ObjectType (PARENT_SOURCELEVEL1OBJECT_TYPE_PTID).
|
void |
setParentSourceLevel2ObjectName(java.lang.String value)
Sets text property ParentSourceLevel2ObjectName (PARENT_SOURCELEVEL2OBJECT_NAME_PTID).
|
void |
setParentSourceLevel2ObjectType(int value)
Sets number property ParentSourceLevel2ObjectType (PARENT_SOURCELEVEL2OBJECT_TYPE_PTID).
|
void |
setParentType(int value)
Sets number property ParentType (PARENT_TYPE_PTID).
|
void |
setPersistentClientInfoLength(int value)
Sets number property PersistentClientInfoLength (PERSISTENT_CLIENT_INFO_LENGTH_PTID).
|
void |
setPrompt(java.lang.String value)
Sets text property Prompt (PROMPT_PTID).
|
void |
setPromptAlign(int value)
Sets number property PromptAlign (PROMPT_ALIGN_PTID).
|
void |
setPromptAlignOffset(int value)
Sets number property PromptAlignOffset (PROMPT_ALIGN_OFFSET_PTID).
|
void |
setPromptAttachmentEdge(int value)
Sets number property PromptAttachmentEdge (PROMPT_ATTACHMENT_EDGE_PTID).
|
void |
setPromptAttachmentOffset(int value)
Sets number property PromptAttachmentOffset (PROMPT_ATTACHMENT_OFFSET_PTID).
|
void |
setPromptBackColor(java.lang.String value)
Sets text property PromptBackColor (PROMPT_BACK_COLOR_PTID).
|
void |
setPromptDisplayStyle(int value)
Sets number property PromptDisplayStyle (PROMPT_DISPLAY_STYLE_PTID).
|
void |
setPromptFillPattern(java.lang.String value)
Sets text property PromptFillPattern (PROMPT_FILL_PATTERN_PTID).
|
void |
setPromptFontName(java.lang.String value)
Sets text property PromptFontName (PROMPT_FONT_NAME_PTID).
|
void |
setPromptFontSize(int value)
Sets number property PromptFontSize (PROMPT_FONT_SIZE_PTID).
|
void |
setPromptFontSpacing(int value)
Sets number property PromptFontSpacing (PROMPT_FONT_SPACING_PTID).
|
void |
setPromptFontStyle(int value)
Sets number property PromptFontStyle (PROMPT_FONT_STYLE_PTID).
|
void |
setPromptFontWeight(int value)
Sets number property PromptFontWeight (PROMPT_FONT_WEIGHT_PTID).
|
void |
setPromptForegroundColor(java.lang.String value)
Sets text property PromptForegroundColor (PROMPT_FOREGROUND_COLOR_PTID).
|
void |
setPromptJustification(int value)
Sets number property PromptJustification (PROMPT_JUSTIFICATION_PTID).
|
void |
setPromptReadingOrder(int value)
Sets number property PromptReadingOrder (PROMPT_READING_ORDER_PTID).
|
void |
setPromptVisualAttributeName(java.lang.String value)
Sets text property PromptVisualAttributeName (PROMPT_VISUALATTRIBUTE_NAME_PTID).
|
void |
setPromptVisualAttributeObject(VisualAttribute value)
Set object property PromptVisualAttributeObject (PROMPT_VISUALATTRIBUTE_OBJECT_PTID).
|
void |
setRadioButtonValue(java.lang.String value)
Sets text property RadioButtonValue (RADIOBUTTON_VALUE_PTID).
|
void |
setSubclassSubObject(boolean value)
Sets boolean property SubclassSubObject (SUBCLASS_SUBOBJECT_PTID).
|
void |
setVisible(boolean value)
Sets boolean property Visible (VISIBLE_PTID).
|
void |
setVisualAttributeName(java.lang.String value)
Sets text property VisualAttributeName (VISUALATTRIBUTE_NAME_PTID).
|
void |
setVisualAttributeObject(VisualAttribute value)
Set object property VisualAttributeObject (VISUALATTRIBUTE_OBJECT_PTID).
|
void |
setWidth(int value)
Sets number property Width (WIDTH_PTID).
|
void |
setXPosition(int value)
Sets number property XPosition (X_POSITION_PTID).
|
void |
setYPosition(int value)
Sets number property YPosition (Y_POSITION_PTID).
|
changeOwner, clearObjectPointer, clone, createSubclassedChild, destroy, equals, getBooleanProperty, getChildObjectProperty, getClassName, getClientInfo, getIntegerProperty, getIntegerPropertyString, getJdapiMetaObject, getMetaProperties, getObjectPointer, getObjectProperty, getObjProp, getOwnedObjects, 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 RadioButton(Item parent, java.lang.String name)
parent
- Parent objectname
- Name of the new objectpublic RadioButton(Item parent, java.lang.String name, RadioButton base)
parent
- Parent objectname
- Name of the new objectbase
- RadioButton object to derive frompublic RadioButton(Item parent, java.lang.String name, PropertyClass base)
parent
- Parent objectname
- Name of the new objectbase
- PropertyClass object to derive frompublic RadioButton(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectpublic RadioButton(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, RadioButton base)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectbase
- RadioButton object to derive frompublic RadioButton(ObjectLibrary olb, ObjectLibraryTab tab, java.lang.String name, PropertyClass base)
olb
- The ObjectLibrary module to create this object intab
- The tab in the passed ObjectLibrary to attach the new object toname
- Name of the new objectbase
- PropertyClass object to derive fromprotected RadioButton(long pd2frdb)
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);
pd2frdb
- C pointer to Forms objectpublic int getTypeId()
getTypeId
in interface JdapiObject
getTypeId
in class BaseFormsObject
queryType
public RadioButton clone(Item parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic RadioButton clone(ObjectLibraryTab parent, java.lang.String newName)
parent
- Parent objectnewName
- Name of object that's being createdpublic static RadioButton find(Item parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic static RadioButton find(ObjectLibraryTab parent, java.lang.String name)
parent
- Parent object of object you wish to findname
- Name of object you wish to findpublic java.lang.String getAccessKey()
public void setAccessKey(java.lang.String value)
value
- Value to set property topublic java.lang.String getBackColor()
public void setBackColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getComment()
public void setComment(java.lang.String value)
value
- Value to set property topublic java.lang.String getFillPattern()
public void setFillPattern(java.lang.String value)
value
- Value to set property topublic java.lang.String getFontName()
public void setFontName(java.lang.String value)
value
- Value to set property topublic java.lang.String getForegroundColor()
public void setForegroundColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getLabel()
public void setLabel(java.lang.String value)
value
- Value to set property topublic 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 java.lang.String getParentFilename()
public void setParentFilename(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentFilepath()
public void setParentFilepath(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentModule()
public void setParentModule(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentName()
public void setParentName(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentSourceLevel1ObjectName()
public void setParentSourceLevel1ObjectName(java.lang.String value)
value
- Value to set property topublic java.lang.String getParentSourceLevel2ObjectName()
public void setParentSourceLevel2ObjectName(java.lang.String value)
value
- Value to set property topublic java.lang.String getPrompt()
public void setPrompt(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptBackColor()
public void setPromptBackColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptFillPattern()
public void setPromptFillPattern(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptFontName()
public void setPromptFontName(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptForegroundColor()
public void setPromptForegroundColor(java.lang.String value)
value
- Value to set property topublic java.lang.String getPromptVisualAttributeName()
public void setPromptVisualAttributeName(java.lang.String value)
value
- Value to set property topublic java.lang.String getRadioButtonValue()
public void setRadioButtonValue(java.lang.String value)
value
- Value to set property topublic java.lang.String getVisualAttributeName()
public void setVisualAttributeName(java.lang.String value)
value
- Value to set property topublic int getDistanceBetweenRecords()
public void setDistanceBetweenRecords(int value)
value
- Value to set property topublic int getFontSize()
public void setFontSize(int value)
value
- Value to set property topublic int getFontSpacing()
public void setFontSpacing(int value)
value
- Value to set property topublic int getFontStyle()
public void setFontStyle(int value)
value
- Value to set property topublic int getFontWeight()
public void setFontWeight(int value)
value
- Value to set property topublic int getHeight()
public void setHeight(int value)
value
- Value to set property topublic int getParentModuleType()
public void setParentModuleType(int value)
value
- Value to set property topublic int getParentSourceLevel1ObjectType()
public void setParentSourceLevel1ObjectType(int value)
value
- Value to set property topublic int getParentSourceLevel2ObjectType()
public void setParentSourceLevel2ObjectType(int value)
value
- Value to set property topublic int getParentType()
public void setParentType(int value)
value
- Value to set property topublic int getPersistentClientInfoLength()
public void setPersistentClientInfoLength(int value)
value
- Value to set property topublic int getPromptAlign()
public void setPromptAlign(int value)
value
- Value to set property topublic int getPromptAlignOffset()
public void setPromptAlignOffset(int value)
value
- Value to set property topublic int getPromptAttachmentEdge()
public void setPromptAttachmentEdge(int value)
value
- Value to set property topublic int getPromptAttachmentOffset()
public void setPromptAttachmentOffset(int value)
value
- Value to set property topublic int getPromptDisplayStyle()
public void setPromptDisplayStyle(int value)
value
- Value to set property topublic int getPromptFontSize()
public void setPromptFontSize(int value)
value
- Value to set property topublic int getPromptFontSpacing()
public void setPromptFontSpacing(int value)
value
- Value to set property topublic int getPromptFontStyle()
public void setPromptFontStyle(int value)
value
- Value to set property topublic int getPromptFontWeight()
public void setPromptFontWeight(int value)
value
- Value to set property topublic int getPromptJustification()
public void setPromptJustification(int value)
value
- Value to set property topublic int getPromptReadingOrder()
public void setPromptReadingOrder(int value)
value
- Value to set property topublic int getWidth()
public void setWidth(int value)
value
- Value to set property topublic int getXPosition()
public void setXPosition(int value)
value
- Value to set property topublic int getYPosition()
public void setYPosition(int value)
value
- Value to set property topublic boolean isDirtyInfo()
public void setDirtyInfo(boolean value)
value
- Value to set property topublic boolean isEnabled()
public void setEnabled(boolean value)
value
- Value to set property topublic boolean isSubclassSubObject()
public void setSubclassSubObject(boolean value)
value
- Value to set property topublic boolean isVisible()
public void setVisible(boolean value)
value
- Value to set property topublic JdapiObject getModule()
getModule
in interface JdapiObject
getModule
in class BaseFormsObject
public JdapiObject getOwner()
getOwner
in interface JdapiObject
getOwner
in class BaseFormsObject
public VisualAttribute getPromptVisualAttributeObject()
public void setPromptVisualAttributeObject(VisualAttribute value)
value
- VisualAttribute object to set property topublic JdapiObject getSource()
public VisualAttribute getVisualAttributeObject()
public void setVisualAttributeObject(VisualAttribute value)
value
- VisualAttribute object to set property to