new PrintItem(config)
Object to hold print item information.
Parameters:
| Name | Type | Description |
|---|---|---|
config |
Object | Configuration for this object. The config supplied directly extends the control |
Members
events
Properties:
| Name | Type | Description |
|---|---|---|
events |
Cadcorp.Util.Events | event object |
labels
Properties:
| Name | Type | Description |
|---|---|---|
labels |
Object | labels |
prompt
Properties:
| Name | Type | Description |
|---|---|---|
prompt |
string | Prompt to use in GeognoSIS |
value
Properties:
| Name | Type | Description |
|---|---|---|
value |
string | item value to use. |
Methods
destroy()
Destroys the print item.
(protected) getItemFailed_handler(jqXHR, textStatus, errorThrown)
Handles the failure of the get item method.
Parameters:
| Name | Type | Description |
|---|---|---|
jqXHR |
Object | response object. |
textStatus |
string | text status |
errorThrown |
Object | exception |
(protected) getItemPropertiesFailed_handler(jqXHR, textStatus, errorThrown)
Handles the failed returning of item properties.
Parameters:
| Name | Type | Description |
|---|---|---|
jqXHR |
Object | response object. |
textStatus |
string | text status |
errorThrown |
Object | exception |
(protected) getItemPropertiesSuccess_handler(e)
Handles the correct returning of item properties.
Parameters:
| Name | Type | Description |
|---|---|---|
e |
Object | event args |
(protected) getItemSuccess_handler(e)
Handles the successful get item method.
Parameters:
| Name | Type | Description |
|---|---|---|
e |
Object | event arguments |
updateItem(geognoSISUrl, sessionID)
Returns the item url based.
Parameters:
| Name | Type | Description |
|---|---|---|
geognoSISUrl |
string | GeognoSIS URL |
sessionID |
string | GeognoSIS Session ID |
(protected) updateItemFailed_handler(jqXHR, textStatus, errorThrown)
Parameters:
| Name | Type | Description |
|---|---|---|
jqXHR |
Object | response object. |
textStatus |
string | text status |
errorThrown |
Object | exception |
(protected) updateItemSuccess_handler(e)
Parameters:
| Name | Type | Description |
|---|---|---|
e |
Object | event args |
Events
Complete
Event indicating that the items have had values set.
Type:
- Object
Error
Event indicating that the attempt to set the text failed.
Type:
- Object
Error
error object
Type:
NoMatchingPrompt
Item not found message
Type:
- Object
Success
Event indicating that the text was set correctly.
Type:
- Object