Class: FooterItem

Cadcorp.UI.FooterItem

new FooterItem(config)

Displays a footer item.
Parameters:
Name Type Description
config Object Configuration for this object. The config supplied directly extends the control

Members

closeText

Properties:
Name Type Description
closeText string The text added to the close button

customButtonAltImageCssClass

Properties:
Name Type Description
customButtonAltImageCssClass string Alternate css class to use for the custom button image. This class is used when customButtonChecked is false. Only used if showCustomButton is true.

customButtonChecked

Properties:
Name Type Description
customButtonChecked boolean True to show a use customButtonImageCssClass, false to use customButtonAltImageCssClass. Only used if showCustomButton is true., otherwise false

customButtonCssClass

Properties:
Name Type Description
customButtonCssClass string The css class to use for the custom button. Only used if showCustomButton is true.

customButtonImageCssClass

Properties:
Name Type Description
customButtonImageCssClass string The css class to use for the custom button image. This class is used when customButtonChecked is true. Only used if showCustomButton is true.

customButtonText

Properties:
Name Type Description
customButtonText string The text for the custom button. Only used if showCustomButton is true.

events

Properties:
Name Type Description
events Cadcorp.Util.Events The events object

id

Properties:
Name Type Description
id string The unique id of this footer item

showCloseButton

Properties:
Name Type Description
showCloseButton boolean True to show a close button, otherwise false

showCustomButton

Properties:
Name Type Description
showCustomButton boolean True to show a custom button, otherwise false

text

Properties:
Name Type Description
text string The text to display in the footer

Methods

getUI() → {Object}

Gets the UI for this footer item
Returns:
A jQuery object that contains this footer item
Type
Object

hide()

Hides this footer item

show()

Shows this footer item

Events

click

Click event
Type:
  • Object
Properties:
Name Type Description
object Cadcorp.UI.FooterItem The sender of the event

close

Close event
Type:
  • Object
Properties:
Name Type Description
object Cadcorp.UI.FooterItem The sender of the event

customButtonClick

Custom button click event
Type:
  • Object
Properties:
Name Type Description
object Cadcorp.UI.FooterItem The sender of the event
checked boolean True id the button is checked, otherwise false