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.

Index

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

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

Group joins multiple actions into a single action.

func (ActionGroup) GetCallbackAction

func (g ActionGroup) GetCallbackAction() FrameworkCallbackActionI

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

HasCallbackAction is called by the framework to determine if the action group has a callback action in it.

func (ActionGroup) HasServerAction

func (g ActionGroup) HasServerAction() bool

HasServerAction is called by the framework to determine if the action group has a server action in it.

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

func AddClass

func AddClass(controlID string, classes string) ActionI

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

func Blur

func Blur(controlID string) ActionI

Blur will blur the html object specified by the id.

func Confirm

func Confirm(m interface{}) ActionI

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{}) ActionI

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

func Focus

func Focus(controlID string) ActionI

Focus will focus the html object specified by the id.

func GoraddFunction

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

GoraddFunction calls a goradd function defined on the goradd object in goradd.js.

func Hide

func Hide(controlID string) ActionI

Hide will hide the given control

func Javascript

func Javascript(js string) ActionI

Javascript will execute the given javascript

func Message

func Message(m interface{}) ActionI

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

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 Refresh

func Refresh(id string) ActionI

Refresh will cause the given control to redraw

func RemoveClass

func RemoveClass(controlID string, classes string) ActionI

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

func Select

func Select(controlID string) ActionI

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

func SetControlValue

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

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.NewJsCode("event.target.id"))

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

func Show

func Show(controlID string) ActionI

Show will show the given control if it is hidden

func ToggleClass

func ToggleClass(controlID string, classes string) ActionI

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{}) ActionI

Trigger will trigger a javascript event on a control

func WidgetFunction

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

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

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.

This class is exported so that the encoder can see its fields.

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.

type CallbackActionI

type CallbackActionI interface {
	ActionI
	ActionValue(v interface{}) CallbackActionI
	Validator(v int) CallbackActionI
	Async() CallbackActionI
	DestinationControlID(id string) CallbackActionI
}

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

func Ajax

func Ajax(destControlId string, actionID int) CallbackActionI

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 control's 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 Server

func Server(destControlId string, actionId int) CallbackActionI

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 control's 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())

type FrameworkCallbackActionI

type FrameworkCallbackActionI interface {
	// 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 sub-control 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 returns true if this is a server action.
	IsServerAction() bool
}

FrameworkCallbackActionI is the interface the framework uses to access actions. Callback actions must satisfy this interface, as well as the CallbackActionI interface.

This is separated here so that IDEs will not pick up these functions for framework users.

type RenderParams

type RenderParams struct {
	// TriggeringControlID is the id of the control that triggered the action
	TriggeringControlID string
	// ControlActionValue is the control action value that will be received by the Action() function.
	ControlActionValue interface{}
	// EventID is the event that triggered the action
	EventID uint16
	// EventActionValue is the event action value that will be received by the Action() function.
	EventActionValue interface{}
}

RenderParams is used by the framework to give extra parameters that help with some actions.