include/generic/SugarWidgets/SugarWidgetSubPanelTopCreateNoteButton.php
\SugarWidgetSubPanelTopCreateNoteButton
Generic Sugar widget
Properties
$access_key= ''
- Type
- n/a
- Inherited_from
- \SugarWidgetSubPanelTopButton::$$access_key
- Inherited_from
- \SugarWidgetSubPanelTopButtonQuickCreate::$$access_key
$acl= ''
- Type
- n/a
- Inherited_from
- \SugarWidgetSubPanelTopButton::$$acl
- Inherited_from
- \SugarWidgetSubPanelTopButtonQuickCreate::$$acl
$additional_form_fields= ''
- Type
- n/a
- Inherited_from
- \SugarWidgetSubPanelTopButton::$$additional_form_fields
- Inherited_from
- \SugarWidgetSubPanelTopButtonQuickCreate::$$additional_form_fields
$form_value= ''
- Type
- n/a
- Inherited_from
- \SugarWidgetSubPanelTopButton::$$form_value
- Inherited_from
- \SugarWidgetSubPanelTopButtonQuickCreate::$$form_value
$layout_manager= 'null'
null
Details- Type
- n/a
- Inherited_from
- \SugarWidget::$$layout_manager
- Inherited_from
- \SugarWidgetSubPanelTopButton::$$layout_manager
- Inherited_from
- \SugarWidgetSubPanelTopButtonQuickCreate::$$layout_manager
$module= ''
- Type
- n/a
- Inherited_from
- \SugarWidgetSubPanelTopButton::$$module
- Inherited_from
- \SugarWidgetSubPanelTopButtonQuickCreate::$$module
$parent_bean= ''
- Type
- n/a
- Inherited_from
- \SugarWidget::$$parent_bean
- Inherited_from
- \SugarWidgetSubPanelTopButton::$$parent_bean
- Inherited_from
- \SugarWidgetSubPanelTopButtonQuickCreate::$$parent_bean
$title= ''
- Type
- n/a
- Inherited_from
- \SugarWidgetSubPanelTopButton::$$title
- Inherited_from
- \SugarWidgetSubPanelTopButtonQuickCreate::$$title
$widget_id= ''
- Type
- n/a
- Inherited_from
- \SugarWidget::$$widget_id
- Inherited_from
- \SugarWidgetSubPanelTopButton::$$widget_id
- Inherited_from
- \SugarWidgetSubPanelTopButtonQuickCreate::$$widget_id
Methods
SugarWidget(
$layout_manager
)
:
void
Name | Type | Description |
---|---|---|
$layout_manager |
SugarWidgetSubPanelTopButton(
$module
=
'', $title
=
'', $access_key
=
'', $form_value
=
''
)
:
void
Take the keys for the strings and look them up. Module is literal, the rest are label keys
Inherited from: \SugarWidgetSubPanelTopButton::SugarWidgetSubPanelTopButton()\SugarWidgetSubPanelTopButtonQuickCreate::SugarWidgetSubPanelTopButton()Name | Type | Description |
---|---|---|
$module | ||
$title | ||
$access_key | ||
$form_value |
_create_json_encoded_popup_request(
$popup_request_data
)
:
void
Returns a string that is the JSON encoded version of the popup request.
Inherited from: \SugarWidgetSubPanelTopButton::_create_json_encoded_popup_request()\SugarWidgetSubPanelTopButtonQuickCreate::_create_json_encoded_popup_request()Perhaps this function should be moved to a more globally accessible location?
Name | Type | Description |
---|---|---|
$popup_request_data |
_get_form(
$defines, $additionalFormFields
=
null
)
:
void
Name | Type | Description |
---|---|---|
$defines | ||
$additionalFormFields |
display(
$defines, $additionalFormFields
=
null
)
:
void
This default function is used to create the HTML for a simple button
Name | Type | Description |
---|---|---|
$defines | ||
$additionalFormFields |
getTruncatedColumnAlias(
$column_name
)
:
void
getTruncatedColumnAlias This function ensures that a column alias is no more than 28 characters. Should the column_name argument exceed 28 charcters, it creates an alias using the first 22 characters of the column_name plus an md5 of the first 6 characters of the lowercased column_name value.
Inherited from: \SugarWidget::getTruncatedColumnAlias()\SugarWidgetSubPanelTopButton::getTruncatedColumnAlias()\SugarWidgetSubPanelTopButtonQuickCreate::getTruncatedColumnAlias()Name | Type | Description |
---|---|---|
$column_name |
getWidgetId(
$buttonSuffix
=
true
)
:
\id
getSubpanelWidgetId This is a utility function to return a widget's unique id
Inherited from: \SugarWidgetSubPanelTopButton::getWidgetId()\SugarWidgetSubPanelTopButtonQuickCreate::getWidgetId()Name | Type | Description |
---|---|---|
$buttonSuffix |
Type | Description |
---|---|
\id | String label of the widget's unique id |
get_subpanel_relationship_name(
mixed $defines
)
:
void
get_subpanel_relationship_name Get the relationship name based on the subapnel definition
Inherited from: \SugarWidgetSubPanelTopButtonQuickCreate::get_subpanel_relationship_name()Name | Type | Description |
---|---|---|
$defines | mixed | The subpanel definition |
setParentBean(
$parent_bean
)
:
void
Name | Type | Description |
---|---|---|
$parent_bean |
setWidgetId(
\id $id
=
''
)
:
void
setSubpanelWidgetId This is a utility function to set the id for a widget
Inherited from: \SugarWidget::setWidgetId()\SugarWidgetSubPanelTopButton::setWidgetId()\SugarWidgetSubPanelTopButtonQuickCreate::setWidgetId()Name | Type | Description |
---|---|---|
$id | \id | String value to set the widget's unique id |