Class Index | File Index

Classes

Class ObjectProperty


Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ObjectProperty(name, displayedName, type, displayable, modifiable, exportable)
Information about additional property.
Method Summary
Method Attributes Method Name and Description
 
equals(obj)
<static>  
ObjectProperty.fromDescription(description)
Returns an ObjectProperty instance built from the given description.
 
getDisplayedName()
Returns a text used for label and header.
 
getName()
Returns the name of this property.
 
getType()
Returns the type of this property.
 
hashCode()
 
isDisplayable()
Returns whether the value of this property is displayable.
 
isExportable()
Returns whether the value of this property is exportable.
 
isModifiable()
Returns whether the value of this property is modifiable.
Class Detail
ObjectProperty(name, displayedName, type, displayable, modifiable, exportable)
Information about additional property.
Author: Emmanuel Puybaret.
Parameters:
{string} name
{string} displayedName
{ObjectProperty.Type} type
{boolean} displayable
{boolean} modifiable
{boolean} exportable
Method Detail
{boolean} equals(obj)
Parameters:
{Object} obj
Returns:
{boolean}
<static> {ObjectProperty} ObjectProperty.fromDescription(description)
Returns an ObjectProperty instance built from the given description.
Parameters:
{string} 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
Returns:
{ObjectProperty}
{string} getDisplayedName()
Returns a text used for label and header.
Returns:
{string}
{string} getName()
Returns the name of this property.
Returns:
{string}
{ObjectProperty.Type} getType()
Returns the type of this property.
Returns:
{ObjectProperty.Type}
{number} hashCode()
Returns:
{number}
{boolean} isDisplayable()
Returns whether the value of this property is displayable.
Returns:
{boolean}
{boolean} isExportable()
Returns whether the value of this property is exportable.
Returns:
{boolean}
{boolean} isModifiable()
Returns whether the value of this property is modifiable.
Returns:
{boolean}
© Copyright 2024 Space Mushrooms
Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 21 2024 17:43:24 GMT+0200 (CEST)