Object
   |
   +--Klip
         |
         +--Actions.Button

The Actions.Button object provides an API to display a button in the Klip when there are no items visible.

Instead of special "click here to configure" items, use an Action Button in conjunction with Actions.Window to create a Klip with a button that opens a window for further input by a user, such as for configuring the Klip according to the user's preferences .

---

Properties Summary
String	text           The label on the button.

   

Function Summary
function	hide()            Hides the currently displayed button.
function	onClick()            Specifies a Handler Function to call in your JavaScript when the user clicks the button.
function	show( <String> text )            Displays a button with the desired string.

Properties Detail

text

String text

The label on the button.

---

Function Detail

hide

function hide()

Hides the currently displayed button.

---

onClick

function onClick()

Specifies a Handler Function to call in your JavaScript when the user clicks the button.

Example:
The following onLoad() function displays a 'Click to see trace' button that calls showTrace() when the user clicks it.



<?xml version="1.0" encoding="UTF-8" ?>
<klip>
   <identity>
      <title>
         API - Actions.Button
      </title>
   </identity>

   <locations>
      <icon>
         http://www.klipfolio.com/static/klips/klipfolio/sample_icon.png
      </icon>
      <banner>
         http://www.klipfolio.com/static/klips/klipfolio/sample_banner.png   
      </banner>
   </locations>

   <klipscript>
      <![CDATA[

      function onRefresh() {
         return true;
      }

      function onLoad() 
      {
         Actions.Button.show("Click to see trace");
         Actions.Button.onClick = showTrace;
      }


      function showTrace()
      {
         traceln( 'Actions Button has been clicked' );
      }

      ]]> 
   </klipscript>
</klip>
     	

Note: The assignment to the handler function is showTrace, not showTrace(). The former is a function, while the latter is the return value from a function call.

---

show

function show( <String> text )

Displays a button with the desired string.

Parameters:
text - the text of the button currently being displayed

---

Overview   Object  Tree  Index  Help			Klipfolio Dashboard API
PREV OBJECT  NEXT OBJECT	FRAMES    NO FRAMES
SUMMARY: PROPERTY | FUNCTION	DETAIL: PROPERTY | FUNCTION

---

© 2011 Klipfolio Inc. All Rights Reserved.