Uses of Class
com.codename1.properties.PropertyBase

Packages that use PropertyBase

Package	Description
com.codename1.properties	High level property objects that allow us to replace getters/setters in business objects with more convenient storage/parsing mappings while retaining type safety.

Uses of PropertyBase in com.codename1.properties

Subclasses of PropertyBase in com.codename1.properties

Modifier and Type	Class and Description
class	BooleanProperty<K> This is the boolean specific version of property
class	ByteProperty<K> This is the byte specific version of numeric property
class	CharProperty<K> This is the char specific version of numeric property
class	CollectionProperty<T,K> Base class for a property as a collection which can contain multiple elements within
class	DoubleProperty<K> This is the double specific version of numeric property
class	FloatProperty<K> This is the float specific version of numeric property
class	IntProperty<K> This is the integer specific version of numeric property
class	ListProperty<T,K> Base class for a property as a list which can contain multiple elements within
class	LongProperty<K> This is the long specific version of numeric property
class	MapProperty<T1,T2,K> Base class for a property as a Map which can contain multiple elements within it
class	NumericProperty<T,K> This is the base class to all number properties, it introduces nullability and the ability to convert to all number types.
class	Property<T,K> Base class for a property, it can store a generic value of any type and broadcast change events to external listeners
class	SetProperty<T,K> Base class for a property as a set which can contain multiple elements within

Methods in com.codename1.properties that return PropertyBase

Modifier and Type	Method and Description
PropertyBase	PropertyIndex.get(int i) Allows us to get an individual property within the object instance
PropertyBase	PropertyIndex.get(String name) Returns a property by its name
PropertyBase	PropertyIndex.getIgnoreCase(String name) Returns a property by its name regardless of case sensitivity for the name
PropertyBase[]	InstantUI.getOrder() Returns the order of the properties or null if they should use their natural order as they were submitted to the index object
PropertyBase	PropertyIndex.getXmlTextElement() Returns the property that contains the XML text e.g.

Methods in com.codename1.properties that return types with arguments of type PropertyBase

Modifier and Type	Method and Description
Iterator<PropertyBase>	PropertyIndex.iterator() Allows us to traverse the properties with a for-each statement

Methods in com.codename1.properties with parameters of type PropertyBase

Modifier and Type	Method and Description
UiBinding.Binding	UiBinding.bind(PropertyBase prop, Component cmp) Binds the given property to the component using default adapters
UiBinding.Binding	UiBinding.bind(PropertyBase prop, Component cmp, UiBinding.ComponentAdapter adapt) Binds the given property to the component using a custom adapter class
UiBinding.Binding	UiBinding.bindGroup(PropertyBase prop, Object[] values, Component... cmps) Binds the given property to the selected value from the set based on the multiple components.
SQLMap.SelectBuilder	SQLMap.SelectBuilder.equals(PropertyBase property) An equals `=` operator
void	InstantUI.excludeProperties(PropertyBase... exclude) Excludes the properties from the generated UI
void	InstantUI.excludeProperty(PropertyBase exclude) Excludes the property from the generated UI
void	UiBinding.BoundTableModel.excludeProperty(PropertyBase b) The properties that are ignored
String	SQLMap.getColumnName(PropertyBase prop) By default the column name matches the property name unless explicitly modified with this method
SQLMap.SqlType	SQLMap.getSqlType(PropertyBase p) Returns the SQL type for the given column
int	InstantUI.getTextFieldConstraint(PropertyBase p) The text field constraint for the property.
protected Object	SQLMap.SqlType.getValue(Row row, int index, PropertyBase base)
SQLMap.SelectBuilder	SQLMap.SelectBuilder.gt(PropertyBase property) A greater that `>` operator
boolean	InstantUI.isExcludedProperty(PropertyBase exclude) Returns true if the property was excluded from the GUI
boolean	PropertyIndex.isExcludeFromJSON(PropertyBase pb) Indicates whether the given property is excluded from the PropertyIndex.toJSON() method output
boolean	PropertyIndex.isExcludeFromMap(PropertyBase pb) Indicates whether the given property is excluded from the PropertyIndex.toMapRepresentation() method output
boolean	PropertyIndex.isXmlTextElement(PropertyBase p) Toggles whether a given property should act as a text element for this object
SQLMap.SelectBuilder	SQLMap.SelectBuilder.lt(PropertyBase property) A lesser than `<` operator
SQLMap.SelectBuilder	SQLMap.SelectBuilder.notEquals(PropertyBase property) A not equals `<>` operator
SQLMap.SelectBuilder	SQLMap.SelectBuilder.orderBy(PropertyBase property, boolean ascending) An orderBy clause
void	MapAdapter.placeInMap(PropertyBase b, Map m) Places the given property into the given map
void	PropertyChangeListener.propertyChanged(PropertyBase<T,K> p) Event callback for the property change event
void	SQLMap.setColumnName(PropertyBase prop, String name) By default the column name matches the property name unless explicitly modified with this method
void	UiBinding.BoundTableModel.setColumnOrder(PropertyBase... columnOrder) Sets the order of the columns explicitly
void	InstantUI.setComponentClass(PropertyBase p, Class cmpCls) The component class used to map this property
void	UiBinding.BoundTableModel.setEditable(PropertyBase pb, boolean editable) Makes the property editable or uneditable
void	PropertyIndex.setExcludeFromJSON(PropertyBase pb, boolean exclude) Allows us to exclude a specific property from the toJSON process
void	PropertyIndex.setExcludeFromMap(PropertyBase pb, boolean exclude) Allows us to exclude a specific property from the PropertyIndex.toMapRepresentation() process
void	MapAdapter.setFromMap(PropertyBase b, Map m) Sets the value of the property from the map object
void	InstantUI.setMultiChoiceLabels(PropertyBase p, String... labels) A property that's a multi-choice can use this API to define the options used e.g.: iui.setMultiChoiceLabels(c.gender, "Male", "Female", "Undefined"); iui.setMultiChoiceValues(c.gender, "M", "F", "U");
void	InstantUI.setMultiChoiceValues(PropertyBase p, Object... values) A property that's a multi-choice can use this API to define the options used, notice that this API won't work correctly without InstantUI.setMultiChoiceLabels(com.codename1.properties.PropertyBase, java.lang.String...)
void	UiBinding.BoundTableModel.setMultipleChoiceOptions(PropertyBase prop, String... values) Sets the multiple choice option for a string entry, this is useful if a string property can have one of several values.
PreferencesObject	PreferencesObject.setName(PropertyBase pb, String name) Sets the name of the specific field not including the prefix, by default the property name is used
void	InstantUI.setOrder(PropertyBase... order) Sets the order of the properties, notice that this can also replace exclude
boolean	PropertyIndex.setSimpleObject(PropertyBase p, Object val) Sets one of the builtin simple objects into a property
void	SQLMap.setSqlType(PropertyBase p, SQLMap.SqlType type) Sets the sql type for the column
void	InstantUI.setTextFieldConstraint(PropertyBase p, int cons) Sets the text field constraint for the property explicitly, notice that some constraints are implicit unless set manually e.g.
void	UiBinding.BoundTableModel.setValidationConstraint(PropertyBase prop, Constraint c) Sets a validator constraint on the table
void	PropertyIndex.setXmlTextElement(PropertyBase p, boolean t) Toggles whether a given property should act as a text element for this object
static void	UiBinding.unbind(PropertyBase prop) Allows us to unbind the property from binding, this is equivalent to calling UiBinding.Binding.disconnect() on all bindings...
boolean	MapAdapter.useAdapterFor(PropertyBase b) Returns true if the adapter should be used for this property

Constructors in com.codename1.properties with parameters of type PropertyBase

Constructor and Description
PropertyIndex(PropertyBusinessObject parent, String name, PropertyBase... properties) The constructor is essential for a proper property business object