remixlab.bias

Class InteractiveGrabberObject

java.lang.Object

remixlab.bias.GrabberObject

remixlab.bias.InteractiveGrabberObject

All Implemented Interfaces:

Grabber

public class InteractiveGrabberObject
extends GrabberObject

A GrabberObject with a Profile instance which allows Shortcut to Method bindings high-level customization (see all the *Binding*() methods). Refer to Profile.setBinding(Shortcut, String) and Profile.setBinding(Object, Shortcut, String) for the type of actions and method signatures that may be bound.

See Also:

Profile

Constructor Summary

Constructors

Constructor and Description
InteractiveGrabberObject() Empty constructor.
InteractiveGrabberObject(Agent agent) Constructs and adds this interactive-grabber object to the agent pool.
InteractiveGrabberObject(InputHandler inputHandler) Constructs and adds this interactive-grabber object to all agents belonging to the input handler.

Method Summary

Modifier and Type	Method and Description
String	action(Shortcut shortcut) Same as return profile.action(key).
boolean	hasBinding(Shortcut shortcut) Same as return profile.hasBinding(shortcut).
String	info() Returns a description of all the bindings this grabber holds.
String	info(Class<? extends Shortcut> cls) Same as profile.info(cls).
boolean	isActionBound(String action) Same as return profile.isActionBound(action).
void	performInteraction(BogusEvent event) Same as profile.handle(event).
void	removeBinding(Shortcut shortcut) Same as profile.removeBinding(shortcut).
void	removeBindings() Same as profile.removeBindings().
void	removeBindings(Class<? extends Shortcut> cls) Same as profile.removeBindings(cls).
void	setBinding(Object object, Shortcut shortcut, String action) Same as profile.setBinding(object, shortcut, action).
void	setBinding(Shortcut shortcut, String action) Same as profile.setBinding(shortcut, action).
void	setBindings(InteractiveGrabberObject otherGrabber) Same as profile.set(otherGrabber.profile).

Methods inherited from class remixlab.bias.GrabberObject

checkIfGrabsInput, checkIfGrabsInput, grabsInput, grabsInput

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InteractiveGrabberObject

public InteractiveGrabberObject()

Empty constructor.

InteractiveGrabberObject

public InteractiveGrabberObject(Agent agent)

Constructs and adds this interactive-grabber object to the agent pool.

See Also:

Agent.grabbers()

InteractiveGrabberObject

public InteractiveGrabberObject(InputHandler inputHandler)

Constructs and adds this interactive-grabber object to all agents belonging to the input handler.

See Also:

InputHandler.agents()

Method Detail

performInteraction

public void performInteraction(BogusEvent event)

Same as profile.handle(event).

Specified by:

performInteraction in interface Grabber

Overrides:

performInteraction in class GrabberObject

See Also:

Profile.handle(BogusEvent)

setBinding

public void setBinding(Shortcut shortcut,
                       String action)

Same as profile.setBinding(shortcut, action).

Low-level profile handling routine. Call this method to set a binding for a custom bogus event, like this: grabber.setBinding(new CustomShortcut(mask, CustomAgent.CUSTOM_ID), "customBehavior").

See Also:

Profile.setBinding(Shortcut, String), BogusEvent, Shortcut

setBinding

public void setBinding(Object object,
                       Shortcut shortcut,
                       String action)

Same as profile.setBinding(object, shortcut, action).

Low-level profile handling routine. Call this method to set a binding for a custom bogus event, like this: grabber.setBinding(object, new CustomShortcut(mask, CustomAgent.CUSTOM_ID), "customBehavior").

See Also:

Profile.setBinding(Object, Shortcut, String), BogusEvent, Shortcut

setBindings

public void setBindings(InteractiveGrabberObject otherGrabber)

Same as profile.set(otherGrabber.profile).

See Also:

Profile.set(Profile)

hasBinding

public boolean hasBinding(Shortcut shortcut)

Same as return profile.hasBinding(shortcut).

Low-level profile handling routine. Call this method to query for a binding from a custom bogus event, like this: grabber.hasBinding(object, new CustomShortcut(mask, CustomAgent.CUSTOM_ID).

See Also:

Profile.hasBinding(Shortcut), BogusEvent, Shortcut

removeBinding

public void removeBinding(Shortcut shortcut)

Same as profile.removeBinding(shortcut).

Low-level profile handling routine. Call this method to remove a binding for a custom bogus event, like this: grabber.removeBinding(new CustomShortcut(mask, CustomAgent.CUSTOM_ID).

See Also:

Profile.removeBinding(Shortcut), BogusEvent, Shortcut

removeBindings

public void removeBindings()

Same as profile.removeBindings().

See Also:

Profile.removeBindings()

removeBindings

public void removeBindings(Class<? extends Shortcut> cls)

Same as profile.removeBindings(cls).

See Also:

Profile.removeBindings(Class)

info

public String info(Class<? extends Shortcut> cls)

Same as profile.info(cls).

See Also:

Profile.info(Class)

info

public String info()

Returns a description of all the bindings this grabber holds.

action

public String action(Shortcut shortcut)

Same as return profile.action(key).

See Also:

Profile.action(Shortcut)

isActionBound

public boolean isActionBound(String action)

Same as return profile.isActionBound(action).

See Also:

Profile.isActionBound(String)