Package com.inductiveautomation.snap.swing.helpers

Class JComponentHpr<T extends javax.swing.JComponent>

java.lang.Object

com.inductiveautomation.snap.ui.UIHelper<T>

com.inductiveautomation.snap.swing.SwingHelper<T>

com.inductiveautomation.snap.swing.helpers.JComponentHpr<T>

Direct Known Subclasses:

DragWell.Helper, JComboBoxHpr, JListHpr, JMenuItemHpr, JProgressBarHpr, JScrollPaneHpr, JSliderHpr, JSpinnerHpr, JSplitPaneHpr, JTabbedPaneHpr, JTableHpr, JTextComponentHpr, JTreeHpr, LabeledHpr, RJColorWellHpr, RJThumbWheelHpr, SpringsPaneHpr, SwitchPaneHpr

public class JComponentHpr<T extends javax.swing.JComponent>
extends SwingHelper<T>

This class is used to provide Snap UI functionality to Swing JComponents.

Constructor Summary

Constructors

Constructor	Description
JComponentHpr()

Method Summary

Modifier and Type	Method	Description
void	addBinding(T anObj, Binding aBinding)	Adds the individual binding at the given index to given component.
protected SwingEventAdapter	createEventAdapter(T aComponent)	Creates the SwingEventAdapter for component.
java.lang.String	getAutosizing(T aComponent)	Returns the autosizing for the given component.
Binding	getBinding(T anObj, int anIndex)	Returns the individual binding at the given index for given component.
int	getBindingCount(T anObj)	Returns the number of bindings associated with given component.
java.util.List<Binding>	getBindings(T anObj, boolean doCreate)	Returns the list of RibsBindings, with option to create, if missing.
protected javax.swing.event.ChangeListener	getChangeListener()	Returns a change listener suitable for some controls.
java.lang.Object	getChild(T aComp, int anIndex)	Returns the individual child object for given object and index.
int	getChildCount(T aComp)	Returns the number of children for given object.
java.lang.Object	getConstraints(T aComponent)	Returns the constraints for component.
SwingEventAdapter	getEventAdapter(T aComponent, boolean doCreate)	Returns the SwingEventAdapter for component.
java.lang.String	getName(T anObj)	Returns the name of the given component.
UIOwner	getOwner(T anObj)	Returns given component's owner.
java.lang.Object	getParent(T anObj)	Returns the parent object for given object.
protected java.util.List<java.lang.String>	getPropertyNamesImpl(T anObj)	Returns the property names for JComponents.
boolean	getSendActionOnFocusLost(T aComponent)	Returns whether this component should send action when focus lost.
boolean	getSendActionOnFocusLostDefault(T aComponent)	Returns whether given component defaults to send action when it loses focus.
void	initUI(T anObj, UIOwner anOwner)	Initializes newly created object.
boolean	isEnabled(T anObj, UIEvent.Type aType)	Returns whether given event is enabled.
Binding	removeBinding(T anObj, int anIndex)	Removes the binding at the given index from given component.
void	setConstraints(T aComponent, java.lang.Object theConstraints)	Sets the constraints for component.
void	setEnabled(T anObj, UIEvent.Type aType, boolean aValue)	Sets whether given event is enabled.
void	setOwner(T anObj, UIOwner anOwner)	Sets given component's owner.
void	setSendActionOnFocusLost(T aComponent, java.lang.Boolean aValue)	Sets whether this component should sends action when it loses focus.

Methods inherited from class com.inductiveautomation.snap.swing.SwingHelper

getHelper, getSwingHelper, getSwingHelper

Methods inherited from class com.inductiveautomation.snap.ui.UIHelper

enableEvents, getAction, getBinding, getChild, getItemDisplayKey, getItems, getKeyValue, getPropertyNameMapped, getPropertyNames, getSelectedIndex, getSelectedIndexes, getSelectedIndexs, getSelectedItem, getText, getValue, initUIDeep, isEnabled, isPropertyName, isValueAdjusting, removeBinding, setAction, setEnabled, setItemDisplayKey, setItems, setItems, setKeyValue, setSelectedIndex, setSelectedIndexes, setSelectedItem, setText, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

JComponentHpr

public JComponentHpr()

Method Detail

getName

public java.lang.String getName(T anObj)

Returns the name of the given component.

Specified by:

getName in class UIHelper<T extends javax.swing.JComponent>

initUI

public void initUI(T anObj,
                   UIOwner anOwner)

Initializes newly created object.

Overrides:

initUI in class UIHelper<T extends javax.swing.JComponent>

getParent

public java.lang.Object getParent(T anObj)

Returns the parent object for given object.

Specified by:

getParent in class UIHelper<T extends javax.swing.JComponent>

getChildCount

public int getChildCount(T aComp)

Returns the number of children for given object.

Specified by:

getChildCount in class UIHelper<T extends javax.swing.JComponent>

getChild

public java.lang.Object getChild(T aComp,
                                 int anIndex)

Returns the individual child object for given object and index.

Specified by:

getChild in class UIHelper<T extends javax.swing.JComponent>

getOwner

public UIOwner getOwner(T anObj)

Returns given component's owner.

Specified by:

getOwner in class UIHelper<T extends javax.swing.JComponent>

setOwner

public void setOwner(T anObj,
                     UIOwner anOwner)

Sets given component's owner.

Specified by:

setOwner in class UIHelper<T extends javax.swing.JComponent>

getConstraints

public java.lang.Object getConstraints(T aComponent)

Returns the constraints for component.

setConstraints

public void setConstraints(T aComponent,
                           java.lang.Object theConstraints)

Sets the constraints for component.

getAutosizing

public java.lang.String getAutosizing(T aComponent)

Returns the autosizing for the given component.

getChangeListener

protected javax.swing.event.ChangeListener getChangeListener()

Returns a change listener suitable for some controls.

getSendActionOnFocusLost

public boolean getSendActionOnFocusLost(T aComponent)

Returns whether this component should send action when focus lost.

setSendActionOnFocusLost

public void setSendActionOnFocusLost(T aComponent,
                                     java.lang.Boolean aValue)

Sets whether this component should sends action when it loses focus.

getSendActionOnFocusLostDefault

public boolean getSendActionOnFocusLostDefault(T aComponent)

Returns whether given component defaults to send action when it loses focus.

getBindingCount

public int getBindingCount(T anObj)

Returns the number of bindings associated with given component.

Overrides:

getBindingCount in class UIHelper<T extends javax.swing.JComponent>

getBinding

public Binding getBinding(T anObj,
                          int anIndex)

Returns the individual binding at the given index for given component.

Overrides:

getBinding in class UIHelper<T extends javax.swing.JComponent>

getBindings

public java.util.List<Binding> getBindings(T anObj,
                                           boolean doCreate)

Returns the list of RibsBindings, with option to create, if missing.

addBinding

public void addBinding(T anObj,
                       Binding aBinding)

Adds the individual binding at the given index to given component.

Overrides:

addBinding in class UIHelper<T extends javax.swing.JComponent>

removeBinding

public Binding removeBinding(T anObj,
                             int anIndex)

Removes the binding at the given index from given component.

Overrides:

removeBinding in class UIHelper<T extends javax.swing.JComponent>

getPropertyNamesImpl

protected java.util.List<java.lang.String> getPropertyNamesImpl(T anObj)

Returns the property names for JComponents.

Overrides:

getPropertyNamesImpl in class UIHelper<T extends javax.swing.JComponent>

isEnabled

public boolean isEnabled(T anObj,
                         UIEvent.Type aType)

Returns whether given event is enabled.

Specified by:

isEnabled in class UIHelper<T extends javax.swing.JComponent>

setEnabled

public void setEnabled(T anObj,
                       UIEvent.Type aType,
                       boolean aValue)

Sets whether given event is enabled.

Specified by:

setEnabled in class UIHelper<T extends javax.swing.JComponent>

getEventAdapter

public SwingEventAdapter getEventAdapter(T aComponent,
                                         boolean doCreate)

Returns the SwingEventAdapter for component.

createEventAdapter

protected SwingEventAdapter createEventAdapter(T aComponent)

Creates the SwingEventAdapter for component.