Class we_ui_controls_Button

Description

Class to display a button

Located in /ui/controls/Button.php (line 30)

we_core_AbstractObject
   |
   --we_ui_abstract_AbstractElement
      |
      --we_ui_abstract_AbstractFormElement
         |
         --we_ui_controls_Button
Class Constant Summary
 kButtonClassDisabledInnerTable = 'we_ui_controls_Disabled_Button_InnerTable'
 kButtonClassDisabledLeft = 'we_ui_controls_Disabled_Button_Left'
 kButtonClassDisabledMiddle = 'we_ui_controls_Disabled_Button_Middle'
 kButtonClassDisabledNormal = 'we_ui_controls_Disabled_Button'
 kButtonClassDisabledRight = 'we_ui_controls_Disabled_Button_Right'
 kButtonClassInnerTable = 'we_ui_controls_Button_InnerTable'
 kButtonClassLeft = 'we_ui_controls_Button_Left'
 kButtonClassMiddle = 'we_ui_controls_Button_Middle'
 kButtonClassNormal = 'we_ui_controls_Button'
 kButtonClassRight = 'we_ui_controls_Button_Right'
 kIconAddCat = '/webEdition/images/button/icons/add_cat.gif'
 kIconAddDoc = '/webEdition/images/button/icons/add_doc.gif'
 kIconAddField = '/webEdition/images/button/icons/add_field.gif'
 kIconAddFile = '/webEdition/images/button/icons/add_file.gif'
 kIconAddFlash = '/webEdition/images/button/icons/add_flash.gif'
 kIconAddImage = '/webEdition/images/button/icons/add_image.gif'
 kIconAddLink = '/webEdition/images/button/icons/add_link.gif'
 kIconAddListElement = '/webEdition/images/button/icons/add_listelement.gif'
 kIconAddNote = '/webEdition/images/button/icons/add_note.gif'
 kIconAddQuicktime = '/webEdition/images/button/icons/add_quicktime.gif'
 kIconAddSchedule = '/webEdition/images/button/icons/add_schedule.gif'
 kIconAddTemplate = '/webEdition/images/button/icons/add_template.gif'
 kIconAddThumbnail = '/webEdition/images/button/icons/add_thumbnail.gif'
 kIconDatePicker = '/webEdition/images/button/icons/date_picker.gif'
 kIconDirectionDown = '/webEdition/images/button/icons/direction_down.gif'
 kIconDirectionLeft = '/webEdition/images/button/icons/direction_left.gif'
 kIconDirectionRight = '/webEdition/images/button/icons/direction_right.gif'
 kIconDirectionUp = '/webEdition/images/button/icons/direction_up.gif'
 kIconEdit = '/webEdition/images/button/icons/edit_edit.gif'
 kIconEditFlash = '/webEdition/images/button/icons/edit_flash.gif'
 kIconEditImage = '/webEdition/images/button/icons/edit_image.gif'
 kIconEditInclude = '/webEdition/images/button/icons/edit_include.gif'
 kIconEditLink = '/webEdition/images/button/icons/edit_link.gif'
 kIconEditList = '/webEdition/images/button/icons/edit_list.gif'
 kIconEditObject = '/webEdition/images/button/icons/edit_object.gif'
 kIconEditPDF = '/webEdition/images/button/icons/edit_pdf.gif'
 kIconEditQuicktime = '/webEdition/images/button/icons/edit_quicktime.gif'
 kIconEditReal = '/webEdition/images/button/icons/edit_real.gif'
 kIconEditWMP = '/webEdition/images/button/icons/edit_wmp.gif'
 kIconFolderBack = '/webEdition/images/button/icons/fs_back.gif'
 kIconHelp = '/webEdition/images/button/icons/help.gif'
 kIconIconView = '/webEdition/images/button/icons/iconview.gif'
 kIconListview = '/webEdition/images/button/icons/listview.gif'
 kIconMessagesCopy = '/webEdition/images/button/icons/messages_copy.gif'
 kIconMessagesCreate = '/webEdition/images/button/icons/messages_create.gif'
 kIconMessagesCut = '/webEdition/images/button/icons/messages_cut.gif'
 kIconMessagesPaste = '/webEdition/images/button/icons/messages_paste.gif'
 kIconMessagesReply = '/webEdition/images/button/icons/messages_reply.gif'
 kIconMessagesTasks = '/webEdition/images/button/icons/messages_tasks.gif'
 kIconMessagesTrash = '/webEdition/images/button/icons/messages_trash.gif'
 kIconMessagesUpdate = '/webEdition/images/button/icons/messages_update.gif'
 kIconNewBannergroup = '/webEdition/images/button/icons/new_bannergroup.gif'
 kIconNewDirectory = '/webEdition/images/button/icons/new_dir.gif'
 kIconPaymentVal = '/webEdition/images/button/icons/payment_val.gif'
 kIconPlus = '/webEdition/images/button/icons/function_plus.gif'
 kIconPublish = '/webEdition/images/button/icons/function_publish.gif'
 kIconReload = '/webEdition/images/button/icons/function_reload.gif'
 kIconSearch = '/webEdition/images/button/icons/function_search.gif'
 kIconSelectImage = '/webEdition/images/button/icons/select_image.gif'
 kIconShopAddNew = '/webEdition/images/button/icons/shop_addnew.gif'
 kIconShopDelArt = '/webEdition/images/button/icons/shop_delArt.gif'
 kIconShopDelOrd = '/webEdition/images/button/icons/shop_delOrd.gif'
 kIconShopExtArt = '/webEdition/images/button/icons/shop_extArt.gif'
 kIconShopPrefs = '/webEdition/images/button/icons/shop_pref.gif'
 kIconShopSum = '/webEdition/images/button/icons/shop_sum.gif'
 kIconShopVariants = '/webEdition/images/button/icons/shop_variants.gif'
 kIconSpellcheck = '/webEdition/images/button/icons/spellcheck.gif'
 kIconTaskCopy = '/webEdition/images/button/icons/task_copy.gif'
 kIconTaskCreate = '/webEdition/images/button/icons/task_create.gif'
 kIconTaskCut = '/webEdition/images/button/icons/task_cut.gif'
 kIconTaskForward = '/webEdition/images/button/icons/task_forward.gif'
 kIconTaskMessages = '/webEdition/images/button/icons/task_messages.gif'
 kIconTaskPaste = '/webEdition/images/button/icons/task_paste.gif'
 kIconTaskReject = '/webEdition/images/button/icons/task_reject.gif'
 kIconTaskStatus = '/webEdition/images/button/icons/task_status.gif'
 kIconTaskTrash = '/webEdition/images/button/icons/task_trash.gif'
 kIconTaskUpdate = '/webEdition/images/button/icons/task_update.gif'
 kIconTrash = '/webEdition/images/button/icons/function_trash.gif'
 kIconUnpublish = '/webEdition/images/button/icons/function_unpublish.gif'
 kIconView = '/webEdition/images/button/icons/function_view.gif'
Variable Summary
integer $_height
string $_href
string $_icon
string $_imagePath
string $_onClick
string $_onMouseDown
string $_onMouseOut
string $_onMouseUp
string $_target
string $_text
string $_type
string $_width
Method Summary
string getHref ()
string getIcon ()
string getImagePath ()
string getOnClick ()
string getOnMouseDown ()
string getOnMouseOut ()
string getOnMouseUp ()
string getTarget ()
string getText ()
string getTextPosition ()
string getType ()
void __construct ([array $properties = null])
void setHref (string $_href)
void setIcon (string $_icon)
void setImagePath (string $_imagePath)
void setOnClick (string $_onClick)
void setOnMouseDown (string $_onMouseDown)
void setOnMouseOut (string $_onMouseOut)
void setOnMouseUp (string $_onMouseUp)
void setTarget (string $_target)
void setText (string $_text)
void setTextPosition (string $_textPosition)
void setType (string $_type)
string _getButtonContent ()
string _getNonBooleanAttribs (string $attribsString)
string _getWrapperEnd ()
string _getWrapperStart ()
string _renderHTML ()
Variables
integer $_height = 22 (line 496)

height of button will be used for button type=submit for the hidden input type=image

  • access: protected

Redefinition of:
we_ui_abstract_AbstractElement::$_height
height of element. Will be inserted into style attribute
string $_href = '' (line 481)

href attribute

  • access: protected
string $_icon = '' (line 459)

name of internal icon image

  • access: protected
string $_imagePath = '' (line 466)

path of external button image

  • access: protected
string $_onClick = '' (line 524)

onClick attribute

  • access: protected
string $_onMouseDown = '' (line 510)

onMouseDown attribute

  • access: protected
string $_onMouseOut = '' (line 503)

onMouseOut attribute

  • access: protected
string $_onMouseUp = '' (line 517)

onMouseUp attribute

  • access: protected
string $_target = '' (line 488)

target attribute

  • access: protected
string $_text = '' (line 438)

text attribute

  • access: protected
string $_textPosition = 'right' (line 474)

position attribute possible values are: left,right

  • access: protected
string $_type = 'onClick' (line 452)

type of button

  • access: protected
string $_width = '150' (line 445)

width attribute

  • access: protected

Redefinition of:
we_ui_abstract_AbstractElement::$_width
width of element. Will be inserted into style attribute

Inherited Variables

Inherited from we_ui_abstract_AbstractFormElement

we_ui_abstract_AbstractFormElement::$_name

Inherited from we_ui_abstract_AbstractElement

we_ui_abstract_AbstractElement::$_class
we_ui_abstract_AbstractElement::$_CSSFiles
we_ui_abstract_AbstractElement::$_disabled
we_ui_abstract_AbstractElement::$_hidden
we_ui_abstract_AbstractElement::$_id
we_ui_abstract_AbstractElement::$_JSFiles
we_ui_abstract_AbstractElement::$_lang
we_ui_abstract_AbstractElement::$_left
we_ui_abstract_AbstractElement::$_overflow
we_ui_abstract_AbstractElement::$_position
we_ui_abstract_AbstractElement::$_style
we_ui_abstract_AbstractElement::$_title
we_ui_abstract_AbstractElement::$_top
Methods
getHref (line 570)

Retrieve href link of button

  • access: public
string getHref ()
getIcon (line 710)

Retrieve icon of internal button

  • access: public
string getIcon ()
getImagePath (line 730)

Retrieve imagePath of external button

  • access: public
string getImagePath ()
getOnClick (line 690)

Retrieve onClick attribute

  • access: public
string getOnClick ()
getOnMouseDown (line 650)

Retrieve onMouseDown attribute

  • access: public
string getOnMouseDown ()
getOnMouseOut (line 630)

Retrieve onMouseOut attribute

  • access: public
string getOnMouseOut ()
getOnMouseUp (line 670)

Retrieve onMouseUp attribute

  • access: public
string getOnMouseUp ()
getTarget (line 590)

Retrieve target of button = href

  • access: public
string getTarget ()
getText (line 550)

Retrieve text of button

  • access: public
string getText ()
getTextPosition (line 750)

Retrieve textPosition of text

  • access: public
string getTextPosition ()
getType (line 610)

Retrieve type of button

  • access: public
string getType ()
Constructor __construct (line 534)

Constructor

Sets object properties if set in $properties array

  • access: public
void __construct ([array $properties = null])
  • array $properties: associative array containing named object properties

Redefinition of:
we_core_AbstractObject::__construct()
Constructor
setHref (line 580)

Set href of button

  • access: public
void setHref (string $_href)
  • string $_href
setIcon (line 720)

Set icon of internal button

  • access: public
void setIcon (string $_icon)
  • string $_icon
setImagePath (line 740)

Set imagePath of external button

  • access: public
void setImagePath (string $_imagePath)
  • string $_imagePath
setOnClick (line 700)

Set onClick attribute

  • access: public
void setOnClick (string $_onClick)
  • string $_onClick
setOnMouseDown (line 660)

Set onMouseDown attribute

  • access: public
void setOnMouseDown (string $_onMouseDown)
  • string $_onMouseDown
setOnMouseOut (line 640)

Set onMouseOut attribute

  • access: public
void setOnMouseOut (string $_onMouseOut)
  • string $_onMouseOut
setOnMouseUp (line 680)

Set onMouseUp attribute

  • access: public
void setOnMouseUp (string $_onMouseUp)
  • string $_onMouseUp
setTarget (line 600)

Set target of button

  • access: public
void setTarget (string $_target)
  • string $_target
setText (line 560)

Set text of button

  • access: public
void setText (string $_text)
  • string $_text
setTextPosition (line 760)

Set textPosition of text

  • access: public
void setTextPosition (string $_textPosition)
  • string $_textPosition
setType (line 620)

Set type of button

  • access: public
void setType (string $_type)
  • string $_type
_getButtonContent (line 816)

Returns button content, image or text or both

  • access: public
string _getButtonContent ()
_getNonBooleanAttribs (line 878)

Returns string with non boolean attribs to insert into html tag

  • access: protected
string _getNonBooleanAttribs (string $attribsString)
  • string $attribsString: comma separated string with attribute names

Redefinition of:
we_ui_abstract_AbstractElement::_getNonBooleanAttribs()
Returns string with non boolean attribs to insert into html tag
_getWrapperEnd (line 799)

Returns end tag </a> if button is type = href or </div> if button is type = submit

  • access: public
string _getWrapperEnd ()
_getWrapperStart (line 770)

Retrieve start tag <a> if button is type = href or <div> if button is type = submit

  • access: public
string _getWrapperStart ()
_renderHTML (line 909)

Renders and returns HTML of button

  • access: public
string _renderHTML ()

Redefinition of:
we_ui_abstract_AbstractElement::_renderHTML()
Renders and returns HTML of ui element

Inherited Methods

Inherited From we_ui_abstract_AbstractFormElement

we_ui_abstract_AbstractFormElement::getName()
we_ui_abstract_AbstractFormElement::setName()

Inherited From we_ui_abstract_AbstractElement

we_ui_abstract_AbstractElement::addCSSFile()
we_ui_abstract_AbstractElement::addCSSFiles()
we_ui_abstract_AbstractElement::addJSFile()
we_ui_abstract_AbstractElement::addJSFiles()
we_ui_abstract_AbstractElement::computeJSURL()
we_ui_abstract_AbstractElement::getClass()
we_ui_abstract_AbstractElement::getCSSFiles()
we_ui_abstract_AbstractElement::getDisabled()
we_ui_abstract_AbstractElement::getHeight()
we_ui_abstract_AbstractElement::getHidden()
we_ui_abstract_AbstractElement::getHTML()
we_ui_abstract_AbstractElement::getId()
we_ui_abstract_AbstractElement::getJSFiles()
we_ui_abstract_AbstractElement::getJSHTML()
we_ui_abstract_AbstractElement::getLang()
we_ui_abstract_AbstractElement::getLeft()
we_ui_abstract_AbstractElement::getOverflow()
we_ui_abstract_AbstractElement::getPosition()
we_ui_abstract_AbstractElement::getStyle()
we_ui_abstract_AbstractElement::getTitle()
we_ui_abstract_AbstractElement::getTop()
we_ui_abstract_AbstractElement::getWidth()
we_ui_abstract_AbstractElement::setClass()
we_ui_abstract_AbstractElement::setDisabled()
we_ui_abstract_AbstractElement::setHeight()
we_ui_abstract_AbstractElement::setHidden()
we_ui_abstract_AbstractElement::setId()
we_ui_abstract_AbstractElement::setLang()
we_ui_abstract_AbstractElement::setLeft()
we_ui_abstract_AbstractElement::setOverflow()
we_ui_abstract_AbstractElement::setPosition()
we_ui_abstract_AbstractElement::setStyle()
we_ui_abstract_AbstractElement::setTitle()
we_ui_abstract_AbstractElement::setTop()
we_ui_abstract_AbstractElement::setWidth()
we_ui_abstract_AbstractElement::_didRenderHTML()
we_ui_abstract_AbstractElement::_getBooleanAttribs()
we_ui_abstract_AbstractElement::_getComputedClassAttrib()
we_ui_abstract_AbstractElement::_getComputedStyleAttrib()
we_ui_abstract_AbstractElement::_getNonBooleanAttribs()
we_ui_abstract_AbstractElement::_renderHTML()
we_ui_abstract_AbstractElement::_willRenderHTML()

Inherited From we_core_AbstractObject

we_core_AbstractObject::__construct()
Class Constants
kButtonClassDisabledInnerTable = 'we_ui_controls_Disabled_Button_InnerTable' (line 431)

class name for table position within the button if disabled

kButtonClassDisabledLeft = 'we_ui_controls_Disabled_Button_Left' (line 411)

class name for left part of disabled button

kButtonClassDisabledMiddle = 'we_ui_controls_Disabled_Button_Middle' (line 416)

class name for middle part of disabled button

kButtonClassDisabledNormal = 'we_ui_controls_Disabled_Button' (line 406)

Default class name for disabled button

kButtonClassDisabledRight = 'we_ui_controls_Disabled_Button_Right' (line 421)

class name for right part of disabled button

kButtonClassInnerTable = 'we_ui_controls_Button_InnerTable' (line 426)

class name for table position within the button

kButtonClassLeft = 'we_ui_controls_Button_Left' (line 391)

class name for left part of button

kButtonClassMiddle = 'we_ui_controls_Button_Middle' (line 396)

class name for middle part of button

kButtonClassNormal = 'we_ui_controls_Button' (line 386)

Default class name for button

kButtonClassRight = 'we_ui_controls_Button_Right' (line 401)

class name for right part of button

kIconAddCat = '/webEdition/images/button/icons/add_cat.gif' (line 36)
kIconAddDoc = '/webEdition/images/button/icons/add_doc.gif' (line 41)
kIconAddField = '/webEdition/images/button/icons/add_field.gif' (line 46)
kIconAddFile = '/webEdition/images/button/icons/add_file.gif' (line 51)
kIconAddFlash = '/webEdition/images/button/icons/add_flash.gif' (line 56)
kIconAddImage = '/webEdition/images/button/icons/add_image.gif' (line 61)
kIconAddLink = '/webEdition/images/button/icons/add_link.gif' (line 66)
kIconAddListElement = '/webEdition/images/button/icons/add_listelement.gif' (line 71)
kIconAddNote = '/webEdition/images/button/icons/add_note.gif' (line 76)
kIconAddQuicktime = '/webEdition/images/button/icons/add_quicktime.gif' (line 81)
kIconAddSchedule = '/webEdition/images/button/icons/add_schedule.gif' (line 86)
kIconAddTemplate = '/webEdition/images/button/icons/add_template.gif' (line 91)
kIconAddThumbnail = '/webEdition/images/button/icons/add_thumbnail.gif' (line 96)
kIconDatePicker = '/webEdition/images/button/icons/date_picker.gif' (line 101)
kIconDirectionDown = '/webEdition/images/button/icons/direction_down.gif' (line 106)
kIconDirectionLeft = '/webEdition/images/button/icons/direction_left.gif' (line 111)
kIconDirectionRight = '/webEdition/images/button/icons/direction_right.gif' (line 116)
kIconDirectionUp = '/webEdition/images/button/icons/direction_up.gif' (line 121)
kIconEdit = '/webEdition/images/button/icons/edit_edit.gif' (line 126)
kIconEditFlash = '/webEdition/images/button/icons/edit_flash.gif' (line 131)
kIconEditImage = '/webEdition/images/button/icons/edit_image.gif' (line 136)
kIconEditInclude = '/webEdition/images/button/icons/edit_include.gif' (line 141)
kIconEditLink = '/webEdition/images/button/icons/edit_link.gif' (line 146)
kIconEditList = '/webEdition/images/button/icons/edit_list.gif' (line 151)
kIconEditObject = '/webEdition/images/button/icons/edit_object.gif' (line 156)
kIconEditPDF = '/webEdition/images/button/icons/edit_pdf.gif' (line 161)
kIconEditQuicktime = '/webEdition/images/button/icons/edit_quicktime.gif' (line 166)
kIconEditReal = '/webEdition/images/button/icons/edit_real.gif' (line 171)
kIconEditWMP = '/webEdition/images/button/icons/edit_wmp.gif' (line 176)
kIconFolderBack = '/webEdition/images/button/icons/fs_back.gif' (line 181)
kIconHelp = '/webEdition/images/button/icons/help.gif' (line 221)
kIconIconView = '/webEdition/images/button/icons/iconview.gif' (line 226)
kIconListview = '/webEdition/images/button/icons/listview.gif' (line 231)
kIconMessagesCopy = '/webEdition/images/button/icons/messages_copy.gif' (line 236)
kIconMessagesCreate = '/webEdition/images/button/icons/messages_create.gif' (line 241)
kIconMessagesCut = '/webEdition/images/button/icons/messages_cut.gif' (line 246)
kIconMessagesPaste = '/webEdition/images/button/icons/messages_paste.gif' (line 251)
kIconMessagesReply = '/webEdition/images/button/icons/messages_reply.gif' (line 256)
kIconMessagesTasks = '/webEdition/images/button/icons/messages_tasks.gif' (line 261)
kIconMessagesTrash = '/webEdition/images/button/icons/messages_trash.gif' (line 266)
kIconMessagesUpdate = '/webEdition/images/button/icons/messages_update.gif' (line 271)
kIconNewBannergroup = '/webEdition/images/button/icons/new_bannergroup.gif' (line 276)
kIconNewDirectory = '/webEdition/images/button/icons/new_dir.gif' (line 281)
kIconPaymentVal = '/webEdition/images/button/icons/payment_val.gif' (line 286)
kIconPlus = '/webEdition/images/button/icons/function_plus.gif' (line 186)
kIconPublish = '/webEdition/images/button/icons/function_publish.gif' (line 191)
kIconReload = '/webEdition/images/button/icons/function_reload.gif' (line 196)
kIconSearch = '/webEdition/images/button/icons/function_search.gif' (line 201)
kIconSelectImage = '/webEdition/images/button/icons/select_image.gif' (line 291)
kIconShopAddNew = '/webEdition/images/button/icons/shop_addnew.gif' (line 296)
kIconShopDelArt = '/webEdition/images/button/icons/shop_delArt.gif' (line 301)
kIconShopDelOrd = '/webEdition/images/button/icons/shop_delOrd.gif' (line 306)
kIconShopExtArt = '/webEdition/images/button/icons/shop_extArt.gif' (line 311)
kIconShopPrefs = '/webEdition/images/button/icons/shop_pref.gif' (line 316)
kIconShopSum = '/webEdition/images/button/icons/shop_sum.gif' (line 321)
kIconShopVariants = '/webEdition/images/button/icons/shop_variants.gif' (line 326)
kIconSpellcheck = '/webEdition/images/button/icons/spellcheck.gif' (line 331)
kIconTaskCopy = '/webEdition/images/button/icons/task_copy.gif' (line 336)
kIconTaskCreate = '/webEdition/images/button/icons/task_create.gif' (line 341)
kIconTaskCut = '/webEdition/images/button/icons/task_cut.gif' (line 346)
kIconTaskForward = '/webEdition/images/button/icons/task_forward.gif' (line 351)
kIconTaskMessages = '/webEdition/images/button/icons/task_messages.gif' (line 356)
kIconTaskPaste = '/webEdition/images/button/icons/task_paste.gif' (line 361)
kIconTaskReject = '/webEdition/images/button/icons/task_reject.gif' (line 366)
kIconTaskStatus = '/webEdition/images/button/icons/task_status.gif' (line 371)
kIconTaskTrash = '/webEdition/images/button/icons/task_trash.gif' (line 376)
kIconTaskUpdate = '/webEdition/images/button/icons/task_update.gif' (line 381)
kIconTrash = '/webEdition/images/button/icons/function_trash.gif' (line 206)
kIconUnpublish = '/webEdition/images/button/icons/function_unpublish.gif' (line 211)
kIconView = '/webEdition/images/button/icons/function_view.gif' (line 216)

Documentation generated on Mon, 01 Sep 2008 11:35:33 +0200 by phpDocumentor 1.4.0