com.eteks.sweethome3d.model

Class ObjectProperty

java.lang.Object

com.eteks.sweethome3d.model.ObjectProperty

All Implemented Interfaces:

java.io.Serializable

public class ObjectProperty
extends java.lang.Object
implements java.io.Serializable

Information about additional property.

Since:

7.2

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ObjectProperty.Type Property type.

Constructor Summary

Constructors

Constructor and Description
ObjectProperty(java.lang.String name) Creates a displayable / modifiable property with the given name.
ObjectProperty(java.lang.String name, ObjectProperty.Type type)
ObjectProperty(java.lang.String name, ObjectProperty.Type type, boolean displayable, boolean modifiable, boolean exportable)
ObjectProperty(java.lang.String name, java.lang.String displayedName, ObjectProperty.Type type, boolean displayable, boolean modifiable, boolean exportable)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
static ObjectProperty	fromDescription(java.lang.String description) Returns an ObjectProperty instance built from the given description.
java.lang.String	getDisplayedName() Returns a text used for label and header.
java.lang.String	getName() Returns the name of this property.
ObjectProperty.Type	getType() Returns the type of this property.
int	hashCode()
boolean	isDisplayable() Returns whether the value of this property is displayable.
boolean	isExportable() Returns whether the value of this property is exportable.
boolean	isModifiable() Returns whether the value of this property is modifiable.

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectProperty

public ObjectProperty(java.lang.String name)

Creates a displayable / modifiable property with the given name.

ObjectProperty

public ObjectProperty(java.lang.String name,
                      ObjectProperty.Type type)

ObjectProperty

public ObjectProperty(java.lang.String name,
                      ObjectProperty.Type type,
                      boolean displayable,
                      boolean modifiable,
                      boolean exportable)

ObjectProperty

public ObjectProperty(java.lang.String name,
                      java.lang.String displayedName,
                      ObjectProperty.Type type,
                      boolean displayable,
                      boolean modifiable,
                      boolean exportable)

Method Detail

fromDescription

public static ObjectProperty fromDescription(java.lang.String description)

Returns an ObjectProperty instance built from the given description.

Parameters:

description - a string containing property name possibly followed by a colon, the property type and displayable modifiable exportable displayedName attributes name:(ANY|STRING|DATE|BOOLEAN|INTEGER|NUMBER|PRICE|LENGTH|PERCENTAGE|CONTENT) displayable=(true|false) modifiable=(true|false) exportable=(true|false) displayedName=text

getName

public java.lang.String getName()

Returns the name of this property.

getType

public ObjectProperty.Type getType()

Returns the type of this property.

isDisplayable

public boolean isDisplayable()

Returns whether the value of this property is displayable.

isModifiable

public boolean isModifiable()

Returns whether the value of this property is modifiable.

isExportable

public boolean isExportable()

Returns whether the value of this property is exportable.

getDisplayedName

public java.lang.String getDisplayedName()

Returns a text used for label and header.

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object