include/generic/SugarWidgets/SugarWidgetSubPanelTopSelectButton.php

Show:

inherited

Classes
- \SugarWidgetSubPanelTopSelectButton

Table of Contents

\SugarWidgetSubPanelTopSelectButton
jump to top

Package:

Generic Sugar widget

Parent(s): \SugarWidgetSubPanelTopButton < \SugarWidget
Children: \SugarWidgetSubPanelTopSelectAccountButton; \SugarWidgetSubPanelTopSelectReportsButton; \SugarWidgetSubPanelTopSelectUsersButton; \SugarWidgetSubPanelTopSelectContactsButton

Properties


                 $access_key= ''

inheritedInherited from: \SugarWidgetSubPanelTopButton::$$access_key

Details

Type: n/a
Inherited_from: \SugarWidgetSubPanelTopButton::$$access_key


                 $acl= ''

inheritedInherited from: \SugarWidgetSubPanelTopButton::$$acl

Details

Type: n/a
Inherited_from: \SugarWidgetSubPanelTopButton::$$acl


                 $additional_form_fields= ''

inheritedInherited from: \SugarWidgetSubPanelTopButton::$$additional_form_fields

Details

Type: n/a
Inherited_from: \SugarWidgetSubPanelTopButton::$$additional_form_fields


                 $form_value= ''

inheritedInherited from: \SugarWidgetSubPanelTopButton::$$form_value

Details

Type: n/a
Inherited_from: \SugarWidgetSubPanelTopButton::$$form_value


                 $layout_manager= 'null'

inheritedInherited from: \SugarWidget::$$layout_manager \SugarWidgetSubPanelTopButton::$$layout_manager

Default valuenullDetails

Type: n/a
Inherited_from: \SugarWidget::$$layout_manager
Inherited_from: \SugarWidgetSubPanelTopButton::$$layout_manager


                 $module= ''

inheritedInherited from: \SugarWidgetSubPanelTopButton::$$module

Details

Type: n/a
Inherited_from: \SugarWidgetSubPanelTopButton::$$module


                 $parent_bean= ''

inheritedInherited from: \SugarWidget::$$parent_bean \SugarWidgetSubPanelTopButton::$$parent_bean

Details

Type: n/a
Inherited_from: \SugarWidget::$$parent_bean
Inherited_from: \SugarWidgetSubPanelTopButton::$$parent_bean


                 $title= ''

inheritedInherited from: \SugarWidgetSubPanelTopButton::$$title

Details

Type: n/a
Inherited_from: \SugarWidgetSubPanelTopButton::$$title


                 $widget_id= ''

inheritedInherited from: \SugarWidget::$$widget_id \SugarWidgetSubPanelTopButton::$$widget_id

Details

Type: n/a
Inherited_from: \SugarWidget::$$widget_id
Inherited_from: \SugarWidgetSubPanelTopButton::$$widget_id

Methods

SugarWidget(
           $layout_manager
          )
        
        :
          void

inherited

Inherited from: \SugarWidget::SugarWidget()\SugarWidgetSubPanelTopButton::SugarWidget()

Parameters

Name	Type	Description
$layout_manager

SugarWidgetSubPanelTopButton(
           $module
              =
              '',  $title
              =
              '',  $access_key
              =
              '',  $form_value
              =
              ''
          )
        
        :
          void

inherited

Take the keys for the strings and look them up. Module is literal, the rest are label keys

Inherited from: \SugarWidgetSubPanelTopButton::SugarWidgetSubPanelTopButton()

Parameters

Name	Type	Description
$module
$title
$access_key
$form_value

SugarWidgetSubPanelTopSelectButton(
           $button_properties
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$button_properties

_create_json_encoded_popup_request(
           $popup_request_data
          )
        
        :
          void

inherited

Returns a string that is the JSON encoded version of the popup request.

Inherited from: \SugarWidgetSubPanelTopButton::_create_json_encoded_popup_request()

Perhaps this function should be moved to a more globally accessible location?

Parameters

Name	Type	Description
$popup_request_data

_get_form(
           $defines,  $additionalFormFields
              =
              null,  $asUrl
              =
              false
          )
        
        :
          void

inherited

Inherited from: \SugarWidgetSubPanelTopButton::_get_form()

Parameters

Name	Type	Description
$defines
$additionalFormFields
$asUrl

display(
           $widget_data
          )
        
        :
          void

This default function is used to create the HTML for a simple button

Parameters

Name	Type	Description
$widget_data

getAccesskey(
          
          )
        
        :
          string

Returns

Type	Description
string

getDisplayName(
          
          )
        
        :
          void

getParentBean(
          
          )
        
        :
          void

inherited

Inherited from: \SugarWidget::getParentBean()\SugarWidgetSubPanelTopButton::getParentBean()

getTitle(
          
          )
        
        :
          string

Returns

Type	Description
string

getTruncatedColumnAlias(
           $column_name
          )
        
        :
          void

inherited

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()

Parameters

Name	Type	Description
$column_name

getWidgetId(
          
          )
        
        :
          \id

getSubpanelWidgetId This is a utility function to return a widget's unique id

Returns

Type	Description
\id	String label of the widget's unique id

get_subpanel_relationship_name(
          mixed $defines
          )
        
        :
          void

inherited

get_subpanel_relationship_name Get the relationship name based on the subapnel definition

Inherited from: \SugarWidgetSubPanelTopButton::get_subpanel_relationship_name()

Parameters

Name	Type	Description
$defines	mixed	The subpanel definition

setParentBean(
           $parent_bean
          )
        
        :
          void

inherited

Inherited from: \SugarWidget::setParentBean()\SugarWidgetSubPanelTopButton::setParentBean()

Parameters

Name	Type	Description
$parent_bean

setWidgetId(
          \id $id
              =
              ''
          )
        
        :
          void

inherited

setSubpanelWidgetId This is a utility function to set the id for a widget

Inherited from: \SugarWidget::setWidgetId()\SugarWidgetSubPanelTopButton::setWidgetId()

Parameters

Name	Type	Description
$id	\id	String value to set the widget's unique id

include/generic/SugarWidgets/SugarWidgetSubPanelTopSelectButton.php

\SugarWidgetSubPanelTopSelectButtonjump to top

Properties

Methods

\SugarWidgetSubPanelTopSelectButton
jump to top