action

Documentation

Overview

Package action defines actions that you can trigger using events. Normally you would do this with the .On() function that all goradd controls have.

Defining Your Own Actions You can define your own actions by creating a class that implements the ActionI interface, AND that is encodable by gob.Serialize, meaning it either implements the gob.Encoder interface or exports its structure, AND registers itself with gob.Register so that the gob.Decoder knows how to deserialize it into an interface. We have chosen to export the structures that represent an action here, but we prefix the name of the structures with a greek capital Omega (Ω). We do this to call out that these exported structures and variables are not for general use.

Index

• func AddClass(controlID string, classes string) widgetAction
• func Ajax(destControlId string, actionID int) *ajaxAction
• func Blur(controlID string) widgetAction
• func Confirm(m interface{}) confirmAction
• func Css(controlID string, property string, value interface{}) widgetAction
• func Focus(controlID string) widgetAction
• func GoraddFunction(operation string, arguments ...interface{}) goraddAction
• func Javascript(js string) javascriptAction
• func Message(m interface{}) goraddAction
• func Redirect(url string) redirectAction
• func RemoveClass(controlID string, classes string) widgetAction
• func Select(controlID string) widgetAction
• func Server(destControlId string, actionId int) *serverAction
• func SetControlValue(id string, key string, value interface{}) goraddAction
• func ToggleClass(controlID string, classes string) widgetAction
• func Trigger(controlID string, event string, data interface{}) widgetAction
• func WidgetFunction(controlID string, operation string, arguments ...interface{}) widgetAction
• type ActionGroup
  • func Group(actions ...ActionI) ActionGroup
  • func (g ActionGroup) GetCallbackAction() CallbackActionI
  • func (g ActionGroup) HasCallbackAction() bool
  • func (g ActionGroup) HasServerAction() bool
  • func (g ActionGroup) RenderScript(params RenderParams) (s string)
• type ActionI
• type CallbackAction
  • func (a *CallbackAction) GetActionValue() interface{}
  • func (a *CallbackAction) GetDestinationControlID() string
  • func (a *CallbackAction) GetDestinationControlSubID() string
  • func (a *CallbackAction) ID() int
  • func (a *CallbackAction) RenderScript(params RenderParams) string
• type CallbackActionI
• type RenderParams

Functions

func AddClass

func AddClass(controlID string, classes string) widgetAction

AddClass will add the given class, or space separated classes, to the html object specified by the id.

func Ajax

func Ajax(destControlId string, actionID int) *ajaxAction

Ajax creates an ajax action. When the action fires, the Action() function of the Goradd control identified by the destControlId will be called, and the given actionID will be the ID passed in the ActionParams of the call. You can specify a sub id which indicates that the action should be sent to something inside the main control by concatenating the controls id with another id that indicates the internal destination, separated with an underscore.

The returned action uses a Builder pattern to add options, so for example you might call:

myControl.On(event.Click(), action.Ajax("myControl", MyActionIdConst).ActionValue("myActionValue").Async())

func Blur

func Blur(controlID string) widgetAction

Blur will blur the html object specified by the id.

func Confirm

func Confirm(m interface{}) confirmAction

Confirm will put up a standard browser confirmation dialog box, and will cancel any following actions if the user does not agree.

func Css

func Css(controlID string, property string, value interface{}) widgetAction

Css will set the css property to the given value on the given html object.

func Focus

func Focus(controlID string) widgetAction

Focus will focus the html object specified by the id.

func GoraddFunction

func GoraddFunction(operation string, arguments ...interface{}) goraddAction

GoraddFunction calls a goradd function with the given parameters. This is a function defined on the goradd object in goradd.js.

func Javascript

func Javascript(js string) javascriptAction

Javascript will execute the given javascript

func Message

func Message(m interface{}) goraddAction

Message returns an action that will display a standard browser alert message. Specify a string, or one of the javascript.* types.

func Redirect

func Redirect(url string) redirectAction

Redirect will navigate to the given page. TODO: If javascript is turned off, this should still work. We would need to detect the presence of javascript, and then emit a server action instead

func RemoveClass

func RemoveClass(controlID string, classes string) widgetAction

RemoveClass will turn off the given space separated classes in the html object specified by the id.

func Select

func Select(controlID string) widgetAction

Select will set all of the text in the html object specified by the id. The object should be a text box.

func Server

func Server(destControlId string, actionId int) *serverAction

Server creates a server action, which is an action that will use a POST submission mechanism to trigger the action. Generally, with modern browsers, server actions are not that useful, since they cause an entire page to reload, while Ajax actions do not, and so are Ajax actions are quicker to process. However, there are special cases where a server action might be useful, like: - You are moving to a new page anyway. - You are having trouble making an Ajax action work for some reason, and a Server action might get around the problem. - You are submitting a multi-part form, like when uploading a file. When the action fires, the Action() function of the Goradd control identified by the destControlId will be called, and the given actionID will be the ID passed in the ActionParams of the call. You can specify a sub id which indicates that the action should be sent to something inside the main control by concatenating the controls id with another id that indicates the internal destination, separated with an underscore.

The returned action uses a Builder pattern to add options, so for example you might call:

myControl.On(event.Click(), action.Server("myControl", MyActionIdConst).ActionValue("myActionValue").Async())

func SetControlValue

func SetControlValue(id string, key string, value interface{}) goraddAction

SetControlValue is primarily used by custom controls to set a value that eventually can get picked up by the control in the UpdateFormValues function. It is an aid to tying javascript powered widgets together with the go version of the control. Value gets converted to a javascript value, so use the javascript.* helpers if you want to interpret a javascript value and pass it on. For example:

action.SetControlValue(myControl.ID(), "myKey", javascript.JsCode("event.target.id"))

will pass the id of the target of an event to the receiver of the action.

func ToggleClass

func ToggleClass(controlID string, classes string) widgetAction

ToggleClass will turn on or off the given space separated classes in the html object specified by the id.

func Trigger

func Trigger(controlID string, event string, data interface{}) widgetAction

Trigger will trigger a javascript event on a control

func WidgetFunction

func WidgetFunction(controlID string, operation string, arguments ...interface{}) widgetAction

WidgetFunction calls a goradd widget function in javascript on an html control with the given id. Available functions are defined by the widget object in goradd.js

Types

type ActionGroup

type ActionGroup struct {
	Actions []ActionI
}

ActionGroup groups multiple actions as a single action. To use it, call Group() and pass a list of actions.

func Group

func Group(actions ...ActionI) ActionGroup

Call Group to join multiple actions into a single action.

func (ActionGroup) GetCallbackAction

func (g ActionGroup) GetCallbackAction() CallbackActionI

GetCallbackAction returns the embedded callback action in the group, if one exists. Note that you can only have at most one callback action in a group

func (ActionGroup) HasCallbackAction

func (g ActionGroup) HasCallbackAction() bool

func (ActionGroup) HasServerAction

func (g ActionGroup) HasServerAction() bool

func (ActionGroup) RenderScript

func (g ActionGroup) RenderScript(params RenderParams) (s string)

RenderScript renders the group of actions as a single action.

type ActionI

type ActionI interface {
	// RenderScript is called by the framework to return the action's javascript
	RenderScript(params RenderParams) string
}

ActionI is an interface that defines actions that can be triggered by events

type CallbackAction

type CallbackAction struct {
	ActionID           int
	DestControlID      string
	SubID              string
	Value              interface{}
	ValidationOverride int // overrides the validation setting that is on the control
	CallAsync          bool
}

CallbackAction is a kind of superclass for Ajax and Server actions. Do not use this class directly.

func (*CallbackAction) GetActionValue

func (a *CallbackAction) GetActionValue() interface{}

GetActionValue returns the action value given to the action when it was created.

func (*CallbackAction) GetDestinationControlID

func (a *CallbackAction) GetDestinationControlID() string

GetDestinationControlID returns the control that the action will operate on.

func (*CallbackAction) GetDestinationControlSubID

func (a *CallbackAction) GetDestinationControlSubID() string

GetDestinationControlSubID returns the sub id so that a composite control can send the action to a sub control.

func (*CallbackAction) ID

func (a *CallbackAction) ID() int

ID returns the action id that was defined when the action was created.

func (*CallbackAction) RenderScript

func (a *CallbackAction) RenderScript(params RenderParams) string

type CallbackActionI

type CallbackActionI interface {
	ActionI

	// ID returns the id assigned to the action when the action was created.
	ID() int
	// GetDestinationControlID returns the id that the action was sent to.
	GetDestinationControlID() string
	// GetDestinationControlSubID returns the id of the subcontrol that is the destination of the action, if one was assigned.
	GetDestinationControlSubID() string
	// GetActionValue returns the action value that was assigned to the action when the action was fired.
	GetActionValue() interface{}
	IsServerAction() bool
}

CallbackI defines actions that result in a callback to us. Specifically Server and Ajax actions are defined for now. There is potential for Message action, like through WebSocket, PubHub, etc.

type RenderParams

type RenderParams struct {
	TriggeringControlID string
	ControlActionValue  interface{}
	EventID             uint16
	EventActionValue    interface{}
}