com.simsilica.lemur.props

Class PropertyPanel

java.lang.Object

com.jme3.scene.Spatial

com.jme3.scene.Node

com.simsilica.lemur.Panel

com.simsilica.lemur.props.PropertyPanel

All Implemented Interfaces:

com.jme3.asset.CloneableSmartAsset, com.jme3.collision.Collidable, com.jme3.export.Savable, com.jme3.util.clone.JmeCloneable, com.simsilica.lemur.core.VersionedObject<PropertyPanel>, java.lang.Cloneable

public class PropertyPanel
extends com.simsilica.lemur.Panel
implements com.simsilica.lemur.core.VersionedObject<PropertyPanel>

A panel that supports adding reflected property and field access directly to it, presenting a table of value editors to the user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PropertyPanel.AbstractProperty<T>
protected static interface	PropertyPanel.Access<T>
protected class	PropertyPanel.BooleanProperty
protected class	PropertyPanel.DoubleProperty
protected class	PropertyPanel.EnabledCheckboxModel
protected class	PropertyPanel.EnumProperty
protected class	PropertyPanel.FieldAccess<T>
protected class	PropertyPanel.FloatProperty
protected class	PropertyPanel.IntProperty
static interface	PropertyPanel.Property<T>
protected class	PropertyPanel.PropertyAccess<T>

Nested classes/interfaces inherited from class com.jme3.scene.Spatial

com.jme3.scene.Spatial.BatchHint, com.jme3.scene.Spatial.CullHint

Field Summary

Fields

Modifier and Type	Field and Description
static com.simsilica.lemur.style.ElementId	ELEMENT_ID

Fields inherited from class com.simsilica.lemur.Panel

EFFECT_CLOSE, EFFECT_OPEN, LAYER_BACKGROUND, LAYER_BORDER, LAYER_INSETS

Fields inherited from class com.jme3.scene.Node

children

Fields inherited from class com.jme3.scene.Spatial

batchHint, controls, cullHint, frustrumIntersects, key, localLights, localOverrides, localTransform, name, parent, queueBucket, queueDistance, refreshFlags, RF_BOUND, RF_CHILD_LIGHTLIST, RF_LIGHTLIST, RF_MATPARAM_OVERRIDE, RF_TRANSFORM, shadowMode, userData, worldBound, worldLights, worldOverrides, worldTransform

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PropertyPanel(boolean applyStyles, com.simsilica.lemur.style.ElementId elementId, java.lang.String style)
	PropertyPanel(com.simsilica.lemur.style.ElementId elementId, java.lang.String style)
	PropertyPanel(java.lang.String style)

Method Summary

Modifier and Type	Method and Description
PropertyPanel.Property<java.lang.Boolean>	addBooleanField(java.lang.String name, java.lang.Object bean, java.lang.String field)
PropertyPanel.Property<java.lang.Boolean>	addBooleanProperty(java.lang.String name, java.lang.Object bean, java.lang.String property)
PropertyPanel.Property<java.lang.Double>	addDoubleField(java.lang.String name, java.lang.Object bean, java.lang.String field, double min, double max, double step)
PropertyPanel.Property<java.lang.Double>	addDoubleProperty(java.lang.String name, java.lang.Object bean, java.lang.String property, double min, double max, double step)
PropertyPanel.Property<java.lang.Enum>	addEnumField(java.lang.String name, java.lang.Object bean, java.lang.String field)
PropertyPanel.Property<java.lang.Enum>	addEnumProperty(java.lang.String name, java.lang.Object bean, java.lang.String property)
PropertyPanel.Property<java.lang.Float>	addFloatField(java.lang.String name, java.lang.Object bean, java.lang.String field, float min, float max, float step)
PropertyPanel.Property<java.lang.Float>	addFloatProperty(java.lang.String name, java.lang.Object bean, java.lang.String property, float min, float max, float step)
PropertyPanel.Property<java.lang.Integer>	addIntField(java.lang.String name, java.lang.Object bean, java.lang.String field, int min, int max, int step)
PropertyPanel.Property<java.lang.Integer>	addIntProperty(java.lang.String name, java.lang.Object bean, java.lang.String proprety, int min, int max, int step)
protected void	addProperty(PropertyPanel.AbstractProperty p)
com.simsilica.lemur.core.VersionedReference<PropertyPanel>	createReference()
protected java.lang.reflect.Field	findField(java.lang.Object bean, java.lang.String fieldName)
protected java.beans.PropertyDescriptor	findProperty(java.lang.Object bean, java.lang.String propertyName)
protected PropertyPanel.AbstractProperty[]	getArray()
com.simsilica.lemur.Container	getContainer() Returns the raw container within which the property editors are added.
com.simsilica.lemur.CheckboxModel	getEnabledModel() Returns the model that is used for enabled/disabled state.
protected <T> T	getFieldValue(java.lang.reflect.Field field, java.lang.Object bean)
PropertyPanel	getObject()
protected <T> T	getPropertyValue(java.beans.PropertyDescriptor pd, java.lang.Object bean)
long	getVersion()
void	refresh() Call to force all property editors to refresh their values from the source object.
protected void	resetEnabled()
com.simsilica.lemur.CheckboxModel	setEnabledProperty(java.lang.Object bean, java.lang.String property) Sets a boolean property that is presented as a panel-global "enabled" state.
protected void	setFieldValue(java.lang.reflect.Field field, java.lang.Object bean, java.lang.Object value)
protected void	setPropertyValue(java.beans.PropertyDescriptor pd, java.lang.Object bean, java.lang.Object value)
void	updateLogicalState(float tpf)

Methods inherited from class com.simsilica.lemur.Panel

addEffect, addMouseListener, getAlpha, getBackground, getBorder, getEffectControl, getEffects, getElementId, getInsets, getInsetsComponent, getPreferredSize, getSize, getStyle, hasEffect, initializeDefaultStyles, removeEffect, removeMouseListener, runEffect, setAlpha, setAlpha, setBackground, setBorder, setChildAlpha, setEffects, setInsets, setInsetsComponent, setPreferredSize, setSize, toString

Methods inherited from class com.jme3.scene.Node

attachChild, attachChildAt, breadthFirstTraversal, clone, cloneFields, collideWith, deepClone, depthFirstTraversal, descendantMatches, descendantMatches, descendantMatches, detachAllChildren, detachChild, detachChildAt, detachChildNamed, getChild, getChild, getChildIndex, getChildren, getQuantity, getTriangleCount, getVertexCount, hasChild, oldDeepClone, read, setLightListRefresh, setLodLevel, setMaterial, setMatParamOverrideRefresh, setModelBound, setParent, setTransformRefresh, swapChildren, updateGeometricState, updateModelBound, updateWorldBound, write

Methods inherited from class com.jme3.scene.Spatial

addControl, addLight, addMatParamOverride, breadthFirstTraversal, center, checkCulling, clearMatParamOverrides, clone, forceRefresh, getBatchHint, getControl, getControl, getCullHint, getKey, getLastFrustumIntersection, getLocalBatchHint, getLocalCullHint, getLocalLightList, getLocalMatParamOverrides, getLocalQueueBucket, getLocalRotation, getLocalScale, getLocalShadowMode, getLocalToWorldMatrix, getLocalTransform, getLocalTranslation, getName, getNumControls, getParent, getQueueBucket, getShadowMode, getUserData, getUserDataKeys, getWorldBound, getWorldLightList, getWorldMatParamOverrides, getWorldRotation, getWorldScale, getWorldTransform, getWorldTranslation, hasAncestor, jmeClone, localToWorld, lookAt, matches, move, move, oldClone, removeControl, removeControl, removeFromParent, removeLight, removeMatParamOverride, rotate, rotate, rotateUpTo, runControlRender, scale, scale, setBatchHint, setBoundRefresh, setCullHint, setKey, setLastFrustumIntersection, setLocalRotation, setLocalRotation, setLocalScale, setLocalScale, setLocalScale, setLocalTransform, setLocalTranslation, setLocalTranslation, setName, setQueueBucket, setRequiresUpdates, setShadowMode, setUserData, updateMatParamOverrides, updateWorldLightList, updateWorldTransforms, worldToLocal

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_ID

public static final com.simsilica.lemur.style.ElementId ELEMENT_ID

Constructor Detail

PropertyPanel

public PropertyPanel(java.lang.String style)

PropertyPanel

public PropertyPanel(com.simsilica.lemur.style.ElementId elementId,
                     java.lang.String style)

PropertyPanel

protected PropertyPanel(boolean applyStyles,
                        com.simsilica.lemur.style.ElementId elementId,
                        java.lang.String style)

Method Detail

getArray

protected PropertyPanel.AbstractProperty[] getArray()

refresh

public void refresh()

Call to force all property editors to refresh their values from the source object. This is the only way to get the UI to update if the values have been changed outside of the UI.

getContainer

public com.simsilica.lemur.Container getContainer()

Returns the raw container within which the property editors are added.

findProperty

protected java.beans.PropertyDescriptor findProperty(java.lang.Object bean,
                                                     java.lang.String propertyName)

findField

protected java.lang.reflect.Field findField(java.lang.Object bean,
                                            java.lang.String fieldName)

addProperty

protected void addProperty(PropertyPanel.AbstractProperty p)

resetEnabled

protected void resetEnabled()

setEnabledProperty

public com.simsilica.lemur.CheckboxModel setEnabledProperty(java.lang.Object bean,
                                                            java.lang.String property)

Sets a boolean property that is presented as a panel-global "enabled" state. This is a way of exposing a boolean property as a checkbox model that can be used in an outer UI. Otherwise, for direct boolean property editing just use the normal addBoolean**() methods.

getEnabledModel

public com.simsilica.lemur.CheckboxModel getEnabledModel()

Returns the model that is used for enabled/disabled state. Note: this state currently has no effect on this component itself but is simply a way to expose a single boolean property to the caller as a checkbox model.

addBooleanProperty

public PropertyPanel.Property<java.lang.Boolean> addBooleanProperty(java.lang.String name,
                                                                    java.lang.Object bean,
                                                                    java.lang.String property)

addFloatProperty

public PropertyPanel.Property<java.lang.Float> addFloatProperty(java.lang.String name,
                                                                java.lang.Object bean,
                                                                java.lang.String property,
                                                                float min,
                                                                float max,
                                                                float step)

addDoubleProperty

public PropertyPanel.Property<java.lang.Double> addDoubleProperty(java.lang.String name,
                                                                  java.lang.Object bean,
                                                                  java.lang.String property,
                                                                  double min,
                                                                  double max,
                                                                  double step)

addIntProperty

public PropertyPanel.Property<java.lang.Integer> addIntProperty(java.lang.String name,
                                                                java.lang.Object bean,
                                                                java.lang.String proprety,
                                                                int min,
                                                                int max,
                                                                int step)

addEnumProperty

public PropertyPanel.Property<java.lang.Enum> addEnumProperty(java.lang.String name,
                                                              java.lang.Object bean,
                                                              java.lang.String property)

addBooleanField

public PropertyPanel.Property<java.lang.Boolean> addBooleanField(java.lang.String name,
                                                                 java.lang.Object bean,
                                                                 java.lang.String field)

addFloatField

public PropertyPanel.Property<java.lang.Float> addFloatField(java.lang.String name,
                                                             java.lang.Object bean,
                                                             java.lang.String field,
                                                             float min,
                                                             float max,
                                                             float step)

addDoubleField

public PropertyPanel.Property<java.lang.Double> addDoubleField(java.lang.String name,
                                                               java.lang.Object bean,
                                                               java.lang.String field,
                                                               double min,
                                                               double max,
                                                               double step)

addIntField

public PropertyPanel.Property<java.lang.Integer> addIntField(java.lang.String name,
                                                             java.lang.Object bean,
                                                             java.lang.String field,
                                                             int min,
                                                             int max,
                                                             int step)

addEnumField

public PropertyPanel.Property<java.lang.Enum> addEnumField(java.lang.String name,
                                                           java.lang.Object bean,
                                                           java.lang.String field)

updateLogicalState

public void updateLogicalState(float tpf)

Overrides:

updateLogicalState in class com.jme3.scene.Node

getPropertyValue

protected <T> T getPropertyValue(java.beans.PropertyDescriptor pd,
                                 java.lang.Object bean)

setPropertyValue

protected void setPropertyValue(java.beans.PropertyDescriptor pd,
                                java.lang.Object bean,
                                java.lang.Object value)

getFieldValue

protected <T> T getFieldValue(java.lang.reflect.Field field,
                              java.lang.Object bean)

setFieldValue

protected void setFieldValue(java.lang.reflect.Field field,
                             java.lang.Object bean,
                             java.lang.Object value)

getVersion

public long getVersion()

Specified by:

getVersion in interface com.simsilica.lemur.core.VersionedObject<PropertyPanel>

getObject

public PropertyPanel getObject()

Specified by:

getObject in interface com.simsilica.lemur.core.VersionedObject<PropertyPanel>

createReference

public com.simsilica.lemur.core.VersionedReference<PropertyPanel> createReference()

Specified by:

createReference in interface com.simsilica.lemur.core.VersionedObject<PropertyPanel>