Home (Sweet Home 3D 7.5 API)

java.lang.Object
- com.eteks.sweethome3d.model.Home

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class Home
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
The home managed by the application with its furniture and walls.

Author:

Emmanuel Puybaret

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Home.Property
The properties of a home that may change.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Home.Property` The properties of a home that may change.

Field Summary

Fields
Modifier and Type Field and Description

static long CURRENT_VERSION
The current version of this home.

Fields
Modifier and Type	Field and Description
`static long`	`CURRENT_VERSION` The current version of this home.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Home()` Creates a home with no furniture, no walls, and a height equal to 250 cm.
	`Home(float wallHeight)` Creates a home with no furniture and no walls.
`protected`	`Home(Home home)` Creates a home from an other one.
	`Home(java.util.List<HomePieceOfFurniture> furniture)` Creates a home with the given `furniture`, no walls and a height equal to 250 cm.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDimensionLine(DimensionLine dimensionLine)` Adds the given dimension line to the set of dimension lines of this home.
`void`	`addDimensionLinesListener(CollectionListener<DimensionLine> listener)` Adds the dimension line `listener` in parameter to this home.
`void`	`addFurnitureListener(CollectionListener<HomePieceOfFurniture> listener)` Adds the furniture `listener` in parameter to this home.
`void`	`addLabel(Label label)` Adds the given label to the set of labels of this home.
`void`	`addLabelsListener(CollectionListener<Label> listener)` Adds the label `listener` in parameter to this home.
`void`	`addLevel(Level level)` Adds the given `level` to the list of levels of this home.
`void`	`addLevelsListener(CollectionListener<Level> listener)` Adds the level `listener` in parameter to this home.
`void`	`addPieceOfFurniture(HomePieceOfFurniture piece)` Adds the `piece` in parameter to this home at the end of the furniture list.
`void`	`addPieceOfFurniture(HomePieceOfFurniture piece, int index)` Adds the `piece` in parameter at a given `index`.
`void`	`addPieceOfFurnitureToGroup(HomePieceOfFurniture piece, HomeFurnitureGroup group, int index)` Adds the `piece` in parameter at the `index` in the given `group`.
`void`	`addPolyline(Polyline polyline)` Adds a given `polyline` at the end of the polylines list of this home.
`void`	`addPolyline(Polyline polyline, int index)` Adds a `polyline` at a given `index` of the set of polylines of this home.
`void`	`addPolylinesListener(CollectionListener<Polyline> listener)` Adds the polyline `listener` in parameter to this home.
`void`	`addPropertyChangeListener(Home.Property property, java.beans.PropertyChangeListener listener)` Adds the property change `listener` in parameter to this home.
`void`	`addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)` Adds the property change `listener` in parameter to this home for a specific property name.
`void`	`addRoom(Room room)` Adds the given `room` at the end of the rooms list of this home.
`void`	`addRoom(Room room, int index)` Adds the `room` in parameter at a given `index`.
`void`	`addRoomsListener(CollectionListener<Room> listener)` Adds the room `listener` in parameter to this home.
`void`	`addSelectionListener(SelectionListener listener)` Adds the selection `listener` in parameter to this home.
`void`	`addWall(Wall wall)` Adds the given `wall` to the set of walls of this home.
`void`	`addWallsListener(CollectionListener<Wall> listener)` Adds the wall `listener` in parameter to this home.
`Home`	`clone()` Returns a clone of this home and the objects it contains.
`void`	`deleteDimensionLine(DimensionLine dimensionLine)` Removes the given dimension line from the set of dimension lines of this home.
`void`	`deleteLabel(Label label)` Removes the given label from the set of labels of this home.
`void`	`deleteLevel(Level level)` Removes the given `level` from the set of levels of this home and all the furniture, walls, rooms, dimension lines and labels that belong to this level.
`void`	`deletePieceOfFurniture(HomePieceOfFurniture piece)` Deletes the `piece` in parameter from this home.
`void`	`deletePolyline(Polyline polyline)` Removes a given `polyline` from the set of polylines of this home.
`void`	`deleteRoom(Room room)` Removes the given `room` from the set of rooms of this home.
`void`	`deleteWall(Wall wall)` Removes the given `wall` from the set of walls of this home.
`void`	`deselectItem(Selectable item)` Deselects `item` if it's selected and notifies listeners selection change.
`static java.util.List<Selectable>`	`duplicate(java.util.List<? extends Selectable> items)` Returns a deep copy of home selectable `items`.
`BackgroundImage`	`getBackgroundImage()` Returns the plan background image of this home.
`Camera`	`getCamera()` Returns the camera used to display this home.
`Compass`	`getCompass()` Returns the compass associated to this home.
`java.util.Collection<DimensionLine>`	`getDimensionLines()` Returns an unmodifiable collection of the dimension lines of this home.
`static java.util.List<DimensionLine>`	`getDimensionLinesSubList(java.util.List<? extends Selectable> items)` Returns a sub list of `items` that contains only dimension lines.
`HomeEnvironment`	`getEnvironment()` Returns the environment attributes of this home.
`java.util.List<HomePieceOfFurniture>`	`getFurniture()` Returns an unmodifiable list of the furniture managed by this home.
`java.util.List<ObjectProperty>`	`getFurnitureAdditionalProperties()` Returns the list of furniture additional properties which should be handled in the user interface.
`HomePieceOfFurniture.SortableProperty`	`getFurnitureSortedProperty()` Deprecated. `getFurnitureSortedProperty()` and `setFurnitureSortedProperty(HomePieceOfFurniture.SortableProperty)` should be replaced by calls to `getFurnitureSortedPropertyName()` and `setFurnitureSortedPropertyName(String)` to allow sorting on additional properties.
`java.lang.String`	`getFurnitureSortedPropertyName()` Returns the furniture property name on which home is sorted or `null` if home furniture isn't sorted.
`static java.util.List<HomePieceOfFurniture>`	`getFurnitureSubList(java.util.List<? extends Selectable> items)` Returns a sub list of `items` that contains only home furniture.
`java.util.List<HomePieceOfFurniture.SortableProperty>`	`getFurnitureVisibleProperties()` Deprecated. `getFurnitureVisibleProperties()` and `#setFurnitureVisibleProperties(List)` should be replaced by calls to `getFurnitureVisiblePropertyNames()` and `#setFurnitureSortedPropertyName(List)` to allow displaying additional properties.
`java.util.List<java.lang.String>`	`getFurnitureVisiblePropertyNames()` Returns an unmodifiable list of the furniture property names that are visible.
`java.util.List<HomeObject>`	`getHomeObjects()` Returns all the mutable objects handled by this home.
`java.util.Collection<Label>`	`getLabels()` Returns an unmodifiable collection of the labels of this home.
`static java.util.List<Label>`	`getLabelsSubList(java.util.List<? extends Selectable> items)` Returns a sub list of `items` that contains only labels.
`java.util.List<Level>`	`getLevels()` Returns an unmodifiable collection of the levels of this home.
`java.lang.String`	`getName()` Returns the name of this home.
`java.lang.Number`	`getNumericProperty(java.lang.String name)` Returns the numeric value of the property `name` associated with this home.
`ObserverCamera`	`getObserverCamera()` Returns the camera used to display this home from an observer point of view.
`java.util.List<Polyline>`	`getPolylines()` Returns an unmodifiable collection of the polylines of this home.
`static java.util.List<Polyline>`	`getPolylinesSubList(java.util.List<? extends Selectable> items)` Returns a sub list of `items` that contains only labels.
`HomePrint`	`getPrint()` Returns the print attributes of this home.
`java.lang.String`	`getProperty(java.lang.String name)` Returns the value of the property `name` associated with this home.
`java.util.Collection<java.lang.String>`	`getPropertyNames()` Returns the property names.
`java.util.List<Room>`	`getRooms()` Returns an unmodifiable collection of the rooms of this home.
`static java.util.List<Room>`	`getRoomsSubList(java.util.List<? extends Selectable> items)` Returns a sub list of `items` that contains only rooms.
`java.util.List<Selectable>`	`getSelectableViewableItems()` Returns all the selectable and viewable items in this home, except the observer camera.
`java.util.List<Selectable>`	`getSelectedItems()` Returns an unmodifiable list of the selected items in home.
`Level`	`getSelectedLevel()` Returns the selected level in home or `null` if home has no level.
`java.util.List<Camera>`	`getStoredCameras()` Returns an unmodifiable list of the cameras stored by this home.
`static <T> java.util.List<T>`	`getSubList(java.util.List<? extends Selectable> items, java.lang.Class<T> subListClass)` Returns a sub list of `items` that contains only instances of `subListClass`.
`Camera`	`getTopCamera()` Returns the camera used to display this home from a top point of view.
`long`	`getVersion()` Returns the version of this home, the last time it was serialized or or `CURRENT_VERSION` if it is not serialized yet or was serialized with Sweet Home 3D 0.x.
`java.lang.Object`	`getVisualProperty(java.lang.String name)` Deprecated. `getVisualProperty(String)` and `setVisualProperty(String, Object)` should be replaced by calls to `getProperty(String)` and `setProperty(String, String)` to ensure they can be easily saved and read. Future file format might not save visual properties anymore.
`float`	`getWallHeight()` Returns the wall height of this home.
`java.util.Collection<Wall>`	`getWalls()` Returns an unmodifiable collection of the walls of this home.
`static java.util.List<Wall>`	`getWallsSubList(java.util.List<? extends Selectable> items)` Returns a sub list of `items` that contains only walls.
`boolean`	`isAllLevelsSelection()` Returns `true` if the selected items in this home are from all levels.
`boolean`	`isBasePlanLocked()` Returns `true` if the home objects belonging to the base plan (generally walls, rooms, dimension lines and texts) are locked.
`boolean`	`isEmpty()` Returns `true` if this home doesn't contain any item i.e.
`boolean`	`isFurnitureDescendingSorted()` Returns whether furniture is sorted in ascending or descending order.
`boolean`	`isItemSelected(Selectable item)` Returns `true` if the given `item` is selected in this home
`boolean`	`isModified()` Returns whether the state of this home is modified or not.
`boolean`	`isRecovered()` Returns whether this home was recovered or not.
`boolean`	`isRepaired()` Returns whether this home was repaired or not.
`void`	`removeDimensionLinesListener(CollectionListener<DimensionLine> listener)` Removes the dimension line `listener` in parameter from this home.
`void`	`removeFurnitureListener(CollectionListener<HomePieceOfFurniture> listener)` Removes the furniture `listener` in parameter from this home.
`void`	`removeLabelsListener(CollectionListener<Label> listener)` Removes the label `listener` in parameter from this home.
`void`	`removeLevelsListener(CollectionListener<Level> listener)` Removes the level `listener` in parameter from this home.
`void`	`removePolylinesListener(CollectionListener<Polyline> listener)` Removes the polyline `listener` in parameter from this home.
`void`	`removePropertyChangeListener(Home.Property property, java.beans.PropertyChangeListener listener)` Removes the property change `listener` in parameter from this home.
`void`	`removePropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener)` Removes the property change `listener` in parameter from this object.
`void`	`removeRoomsListener(CollectionListener<Room> listener)` Removes the room `listener` in parameter from this home.
`void`	`removeSelectionListener(SelectionListener listener)` Removes the selection `listener` in parameter from this home.
`void`	`removeWallsListener(CollectionListener<Wall> listener)` Removes the wall `listener` in parameter from this home.
`void`	`setAllLevelsSelection(boolean selectionAtAllLevels)` Sets whether the selected items in this home are from all levels, and notifies listeners of the change.
`void`	`setBackgroundImage(BackgroundImage backgroundImage)` Sets the plan background image of this home and fires a `PropertyChangeEvent`.
`void`	`setBasePlanLocked(boolean basePlanLocked)` Sets whether home objects belonging to the base plan (generally walls, rooms, dimension lines and texts) are locked and fires a `PropertyChangeEvent`.
`void`	`setCamera(Camera camera)` Sets the camera used to display this home and fires a `PropertyChangeEvent`.
`void`	`setFurnitureAdditionalProperties(java.util.List<ObjectProperty> furnitureAdditionalProperties)` Sets the list of furniture additional properties which should be handled in the user interface.
`void`	`setFurnitureDescendingSorted(boolean furnitureDescendingSorted)` Sets the furniture sort order on which home should be sorted and fires a `PropertyChangeEvent`.
`void`	`setFurnitureSortedProperty(HomePieceOfFurniture.SortableProperty furnitureSortedProperty)` Deprecated. `getFurnitureSortedProperty()` and `setFurnitureSortedProperty(HomePieceOfFurniture.SortableProperty)` should be replaced by calls to `getFurnitureSortedPropertyName()` and `setFurnitureSortedPropertyName(String)` to allow sorting on additional properties.
`void`	`setFurnitureSortedPropertyName(java.lang.String furnitureSortedPropertyName)` Sets the furniture property name on which this home should be sorted and fires a `PropertyChangeEvent`.
`void`	`setFurnitureVisibleProperties(java.util.List<HomePieceOfFurniture.SortableProperty> furnitureVisibleProperties)` Deprecated. `getFurnitureVisibleProperties()` and `#setFurnitureVisibleProperties(List)` should be replaced by calls to `getFurnitureVisiblePropertyNames()` and `#setFurnitureSortedPropertyName(List)` to allow displaying additional properties.
`void`	`setFurnitureVisiblePropertyNames(java.util.List<java.lang.String> furnitureVisiblePropertyNames)` Sets the furniture property names that are visible and the order in which they are visible, then fires a `PropertyChangeEvent`.
`void`	`setModified(boolean modified)` Sets the modified state of this home and fires a `PropertyChangeEvent`.
`void`	`setName(java.lang.String name)` Sets the name of this home and fires a `PropertyChangeEvent`.
`void`	`setPrint(HomePrint print)` Sets the print attributes of this home and fires a `PropertyChangeEvent`.
`void`	`setProperty(java.lang.String name, java.lang.String value)` Sets a property associated with this home.
`void`	`setRecovered(boolean recovered)` Sets whether this home was recovered or not and fires a `PropertyChangeEvent`.
`void`	`setRepaired(boolean repaired)` Sets whether this home is repaired or not and fires a `PropertyChangeEvent`.
`void`	`setSelectedItems(java.util.List<? extends Selectable> selectedItems)` Sets the selected items in home and notifies listeners selection change.
`void`	`setSelectedLevel(Level selectedLevel)` Sets the selected level in home and notifies listeners of the change.
`void`	`setStoredCameras(java.util.List<Camera> storedCameras)` Sets the cameras stored by this home and fires a `PropertyChangeEvent`.
`void`	`setVersion(long version)` Sets the version of this home.
`void`	`setVisualProperty(java.lang.String name, java.lang.Object value)` Deprecated. `getVisualProperty(String)` and `setVisualProperty(String, Object)` should be replaced by calls to `getProperty(String)` and `setProperty(String, String)` to ensure they can be easily saved and read. Future file format might not save visual properties anymore.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CURRENT_VERSION
```
public static final long CURRENT_VERSION
```
    The current version of this home. Each time the field list is changed in Home class or in one of the classes that it uses, this number is increased.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Home
```
public Home()
```
    Creates a home with no furniture, no walls, and a height equal to 250 cm.
  - Home
```
public Home(float wallHeight)
```
    Creates a home with no furniture and no walls.
    
    Parameters:
    
    wallHeight - default height for home walls
  - Home
```
public Home(java.util.List<HomePieceOfFurniture> furniture)
```
    Creates a home with the given furniture, no walls and a height equal to 250 cm.
  - Home
```
protected Home(Home home)
```
    Creates a home from an other one. All mutable data of the source home is cloned to this home and listeners support is reset.
    
    Since:
    
    5.0
- Method Detail
  - addLevelsListener
```
public void addLevelsListener(CollectionListener<Level> listener)
```
    Adds the level listener in parameter to this home.
    
    Parameters:
    
    listener - the listener to add
    
    Since:
    
    3.4
  - removeLevelsListener
```
public void removeLevelsListener(CollectionListener<Level> listener)
```
    Removes the level listener in parameter from this home.
    
    Parameters:
    
    listener - the listener to remove
    
    Since:
    
    3.4
  - getLevels
```
public java.util.List<Level> getLevels()
```
    Returns an unmodifiable collection of the levels of this home.
    
    Since:
    
    3.4
  - addLevel
```
public void addLevel(Level level)
```
    Adds the given level to the list of levels of this home. Once the level is added, level listeners added to this home will receive a collectionChanged notification, with an event type equal to ADD.
    
    Parameters:
    
    level - the level to add
    
    Since:
    
    3.4
  - deleteLevel
```
public void deleteLevel(Level level)
```
    Removes the given level from the set of levels of this home and all the furniture, walls, rooms, dimension lines and labels that belong to this level. Once the level is removed, level listeners added to this home will receive a collectionChanged notification, with an event type equal to DELETE.
    
    Parameters:
    
    level - the level to remove
    
    Since:
    
    3.4
  - getSelectedLevel
```
public Level getSelectedLevel()
```
    Returns the selected level in home or null if home has no level.
    
    Since:
    
    3.4
  - setSelectedLevel
```
public void setSelectedLevel(Level selectedLevel)
```
    Sets the selected level in home and notifies listeners of the change.
    
    Parameters:
    
    selectedLevel - the level to select
    
    Since:
    
    3.4
  - isAllLevelsSelection
```
public boolean isAllLevelsSelection()
```
    Returns true if the selected items in this home are from all levels.
    
    Since:
    
    4.4
  - setAllLevelsSelection
```
public void setAllLevelsSelection(boolean selectionAtAllLevels)
```
    Sets whether the selected items in this home are from all levels, and notifies listeners of the change.
    
    Since:
    
    4.4
  - addFurnitureListener
```
public void addFurnitureListener(CollectionListener<HomePieceOfFurniture> listener)
```
    Adds the furniture listener in parameter to this home.
    
    Parameters:
    
    listener - the listener to add
  - removeFurnitureListener
```
public void removeFurnitureListener(CollectionListener<HomePieceOfFurniture> listener)
```
    Removes the furniture listener in parameter from this home.
    
    Parameters:
    
    listener - the listener to remove
  - getFurniture
```
public java.util.List<HomePieceOfFurniture> getFurniture()
```
    Returns an unmodifiable list of the furniture managed by this home. This furniture in this list is always sorted in the index order they were added to home.
  - addPieceOfFurniture
```
public void addPieceOfFurniture(HomePieceOfFurniture piece)
```
    Adds the piece in parameter to this home at the end of the furniture list. Once the piece is added, furniture listeners added to this home will receive a collectionChanged notification.
    
    Parameters:
    
    piece - the piece to add
  - addPieceOfFurniture
```
public void addPieceOfFurniture(HomePieceOfFurniture piece,
                                int index)
```
    Adds the piece in parameter at a given index. Once the piece is added, furniture listeners added to this home will receive a collectionChanged notification.
    
    Parameters:
    
    piece - the piece to add
    
    index - the index at which the piece will be added
  - addPieceOfFurnitureToGroup
```
public void addPieceOfFurnitureToGroup(HomePieceOfFurniture piece,
                                       HomeFurnitureGroup group,
                                       int index)
```
    Adds the piece in parameter at the index in the given group. Once the piece is added, furniture listeners added to this home will receive a collectionChanged notification with an event index equal to -1.
    
    Parameters:
    
    piece - the piece to add
    
    group - the group to which the piece will be added
    
    index - the index at which the piece will be added
  - deletePieceOfFurniture
```
public void deletePieceOfFurniture(HomePieceOfFurniture piece)
```
    Deletes the piece in parameter from this home. Once the piece is deleted, furniture listeners added to this home will receive a collectionChanged notification. If the removed piece belongs to a group, the index of the event will be -1.
    
    Parameters:
    
    piece - the piece to remove
  - addSelectionListener
```
public void addSelectionListener(SelectionListener listener)
```
    Adds the selection listener in parameter to this home.
    
    Parameters:
    
    listener - the listener to add
  - removeSelectionListener
```
public void removeSelectionListener(SelectionListener listener)
```
    Removes the selection listener in parameter from this home.
    
    Parameters:
    
    listener - the listener to remove
  - getSelectedItems
```
public java.util.List<Selectable> getSelectedItems()
```
    Returns an unmodifiable list of the selected items in home.
  - isItemSelected
```
public boolean isItemSelected(Selectable item)
```
    Returns true if the given item is selected in this home
    
    Parameters:
    
    item - a selectable item.
    
    Since:
    
    7.2
  - setSelectedItems
```
public void setSelectedItems(java.util.List<? extends Selectable> selectedItems)
```
    Sets the selected items in home and notifies listeners selection change.
    
    Parameters:
    
    selectedItems - the list of selected items
  - deselectItem
```
public void deselectItem(Selectable item)
```
    Deselects item if it's selected and notifies listeners selection change.
    
    Parameters:
    
    item - the item to remove from selected items
    
    Since:
    
    2.2
  - addRoomsListener
```
public void addRoomsListener(CollectionListener<Room> listener)
```
    Adds the room listener in parameter to this home.
    
    Parameters:
    
    listener - the listener to add
  - removeRoomsListener
```
public void removeRoomsListener(CollectionListener<Room> listener)
```
    Removes the room listener in parameter from this home.
    
    Parameters:
    
    listener - the listener to remove
  - getRooms
```
public java.util.List<Room> getRooms()
```
    Returns an unmodifiable collection of the rooms of this home.
  - addRoom
```
public void addRoom(Room room)
```
    Adds the given room at the end of the rooms list of this home. Once the room is added, room listeners added to this home will receive a collectionChanged notification, with an event type equal to ADD.
    
    Parameters:
    
    room - the room to add
  - addRoom
```
public void addRoom(Room room,
                    int index)
```
    Adds the room in parameter at a given index. Once the room is added, room listeners added to this home will receive a collectionChanged notification, with an event type equal to ADD.
    
    Parameters:
    
    room - the room to add
    
    index - the index at which the room will be added
  - deleteRoom
```
public void deleteRoom(Room room)
```
    Removes the given room from the set of rooms of this home. Once the room is removed, room listeners added to this home will receive a collectionChanged notification, with an event type equal to DELETE.
    
    Parameters:
    
    room - the room to remove
  - addWallsListener
```
public void addWallsListener(CollectionListener<Wall> listener)
```
    Adds the wall listener in parameter to this home.
    
    Parameters:
    
    listener - the listener to add
  - removeWallsListener
```
public void removeWallsListener(CollectionListener<Wall> listener)
```
    Removes the wall listener in parameter from this home.
    
    Parameters:
    
    listener - the listener to remove
  - getWalls
```
public java.util.Collection<Wall> getWalls()
```
    Returns an unmodifiable collection of the walls of this home.
  - addWall
```
public void addWall(Wall wall)
```
    Adds the given wall to the set of walls of this home. Once the wall is added, wall listeners added to this home will receive a collectionChanged notification, with an event type equal to ADD.
    
    Parameters:
    
    wall - the wall to add
  - deleteWall
```
public void deleteWall(Wall wall)
```
    Removes the given wall from the set of walls of this home. Once the wall is removed, wall listeners added to this home will receive a collectionChanged notification, with an event type equal to DELETE. If any wall is attached to wall they will be detached from it.
    
    Parameters:
    
    wall - the wall to remove
  - addPolylinesListener
```
public void addPolylinesListener(CollectionListener<Polyline> listener)
```
    Adds the polyline listener in parameter to this home.
    
    Parameters:
    
    listener - the listener to add
    
    Since:
    
    5.0
  - removePolylinesListener
```
public void removePolylinesListener(CollectionListener<Polyline> listener)
```
    Removes the polyline listener in parameter from this home.
    
    Parameters:
    
    listener - the listener to remove
    
    Since:
    
    5.0
  - getPolylines
```
public java.util.List<Polyline> getPolylines()
```
    Returns an unmodifiable collection of the polylines of this home.
    
    Since:
    
    5.0
  - addPolyline
```
public void addPolyline(Polyline polyline)
```
    Adds a given polyline at the end of the polylines list of this home. Once the polyline is added, polyline listeners added to this home will receive a collectionChanged notification, with an event type equal to ADD.
    
    Parameters:
    
    polyline - the polyline to add
    
    Since:
    
    5.0
  - addPolyline
```
public void addPolyline(Polyline polyline,
                        int index)
```
    Adds a polyline at a given index of the set of polylines of this home. Once the polyline is added, polyline listeners added to this home will receive a collectionChanged notification, with an event type equal to ADD.
    
    Parameters:
    
    polyline - the polyline to add
    
    index - the index at which the polyline will be added
    
    Since:
    
    5.0
  - deletePolyline
```
public void deletePolyline(Polyline polyline)
```
    Removes a given polyline from the set of polylines of this home. Once the polyline is removed, polyline listeners added to this home will receive a collectionChanged notification, with an event type equal to DELETE.
    
    Parameters:
    
    polyline - the polyline to remove
    
    Since:
    
    5.0
  - addDimensionLinesListener
```
public void addDimensionLinesListener(CollectionListener<DimensionLine> listener)
```
    Adds the dimension line listener in parameter to this home.
    
    Parameters:
    
    listener - the listener to add
  - removeDimensionLinesListener
```
public void removeDimensionLinesListener(CollectionListener<DimensionLine> listener)
```
    Removes the dimension line listener in parameter from this home.
    
    Parameters:
    
    listener - the listener to remove
  - getDimensionLines
```
public java.util.Collection<DimensionLine> getDimensionLines()
```
    Returns an unmodifiable collection of the dimension lines of this home.
  - addDimensionLine
```
public void addDimensionLine(DimensionLine dimensionLine)
```
    Adds the given dimension line to the set of dimension lines of this home. Once dimensionLine is added, dimension line listeners added to this home will receive a collectionChanged notification, with an event type equal to ADD.
    
    Parameters:
    
    dimensionLine - the dimension line to add
  - deleteDimensionLine
```
public void deleteDimensionLine(DimensionLine dimensionLine)
```
    Removes the given dimension line from the set of dimension lines of this home. Once dimensionLine is removed, dimension line listeners added to this home will receive a collectionChanged notification, with an event type equal to DELETE.
    
    Parameters:
    
    dimensionLine - the dimension line to remove
  - addLabelsListener
```
public void addLabelsListener(CollectionListener<Label> listener)
```
    Adds the label listener in parameter to this home.
    
    Parameters:
    
    listener - the listener to add
  - removeLabelsListener
```
public void removeLabelsListener(CollectionListener<Label> listener)
```
    Removes the label listener in parameter from this home.
    
    Parameters:
    
    listener - the listener to remove
  - getLabels
```
public java.util.Collection<Label> getLabels()
```
    Returns an unmodifiable collection of the labels of this home.
  - addLabel
```
public void addLabel(Label label)
```
    Adds the given label to the set of labels of this home. Once label is added, label listeners added to this home will receive a collectionChanged notification, with an event type equal to ADD.
    
    Parameters:
    
    label - the label to add
  - deleteLabel
```
public void deleteLabel(Label label)
```
    Removes the given label from the set of labels of this home. Once label is removed, label listeners added to this home will receive a collectionChanged notification, with an event type equal to DELETE.
    
    Parameters:
    
    label - the label to remove
  - getSelectableViewableItems
```
public java.util.List<Selectable> getSelectableViewableItems()
```
    Returns all the selectable and viewable items in this home, except the observer camera.
    
    Returns:
    
    a list containing viewable walls, rooms, furniture, dimension lines, polylines, labels and compass.
    
    Since:
    
    5.0
  - getHomeObjects
```
public java.util.List<HomeObject> getHomeObjects()
```
    Returns all the mutable objects handled by this home.
    
    Returns:
    
    a list containing environment, compass, levels, walls, rooms, furniture and their possible children, polylines, dimension lines, labels and cameras.
    
    Since:
    
    6.4
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if this home doesn't contain any item i.e. no piece of furniture, no wall, no room, no dimension line and no label.
    
    Since:
    
    2.2
  - addPropertyChangeListener
```
public void addPropertyChangeListener(Home.Property property,
                                      java.beans.PropertyChangeListener listener)
```
    Adds the property change listener in parameter to this home. Properties change will be notified with an event of PropertyChangeEvent class which property name will be equal to the value returned by Enum.name() call.
    
    Parameters:
    
    property - the property to follow
    
    listener - the listener to add
  - removePropertyChangeListener
```
public void removePropertyChangeListener(Home.Property property,
                                         java.beans.PropertyChangeListener listener)
```
    Removes the property change listener in parameter from this home.
    
    Parameters:
    
    property - the followed property
    
    listener - the listener to remove
  - getWallHeight
```
public float getWallHeight()
```
    Returns the wall height of this home.
  - getName
```
public java.lang.String getName()
```
    Returns the name of this home.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the name of this home and fires a PropertyChangeEvent.
    
    Parameters:
    
    name - the new name of this home
  - isModified
```
public boolean isModified()
```
    Returns whether the state of this home is modified or not.
  - setModified
```
public void setModified(boolean modified)
```
    Sets the modified state of this home and fires a PropertyChangeEvent.
  - isRecovered
```
public boolean isRecovered()
```
    Returns whether this home was recovered or not.
    
    Since:
    
    3.0
  - setRecovered
```
public void setRecovered(boolean recovered)
```
    Sets whether this home was recovered or not and fires a PropertyChangeEvent.
    
    Since:
    
    3.0
  - isRepaired
```
public boolean isRepaired()
```
    Returns whether this home was repaired or not.
    
    Since:
    
    4.4
  - setRepaired
```
public void setRepaired(boolean repaired)
```
    Sets whether this home is repaired or not and fires a PropertyChangeEvent.
    
    Since:
    
    4.4
  - getFurnitureSortedPropertyName
```
public java.lang.String getFurnitureSortedPropertyName()
```
    Returns the furniture property name on which home is sorted or null if home furniture isn't sorted.
    
    Since:
    
    7.2
  - setFurnitureSortedPropertyName
```
public void setFurnitureSortedPropertyName(java.lang.String furnitureSortedPropertyName)
```
    Sets the furniture property name on which this home should be sorted and fires a PropertyChangeEvent.
    
    Parameters:
    
    furnitureSortedPropertyName - the name of the property
    
    Since:
    
    7.2
  - getFurnitureSortedProperty
```
public HomePieceOfFurniture.SortableProperty getFurnitureSortedProperty()
```
    Deprecated. getFurnitureSortedProperty() and setFurnitureSortedProperty(HomePieceOfFurniture.SortableProperty) should be replaced by calls to getFurnitureSortedPropertyName() and setFurnitureSortedPropertyName(String) to allow sorting on additional properties.
    
    Returns the furniture property on which home is sorted or null if home furniture isn't sorted.
  - setFurnitureSortedProperty
```
public void setFurnitureSortedProperty(HomePieceOfFurniture.SortableProperty furnitureSortedProperty)
```
    Deprecated. getFurnitureSortedProperty() and setFurnitureSortedProperty(HomePieceOfFurniture.SortableProperty) should be replaced by calls to getFurnitureSortedPropertyName() and setFurnitureSortedPropertyName(String) to allow sorting on additional properties.
    
    Sets the furniture property on which this home should be sorted and fires a PropertyChangeEvent.
    
    Parameters:
    
    furnitureSortedProperty - the new property
  - isFurnitureDescendingSorted
```
public boolean isFurnitureDescendingSorted()
```
    Returns whether furniture is sorted in ascending or descending order.
  - setFurnitureDescendingSorted
```
public void setFurnitureDescendingSorted(boolean furnitureDescendingSorted)
```
    Sets the furniture sort order on which home should be sorted and fires a PropertyChangeEvent.
  - getFurnitureVisiblePropertyNames
```
public java.util.List<java.lang.String> getFurnitureVisiblePropertyNames()
```
    Returns an unmodifiable list of the furniture property names that are visible.
    
    Since:
    
    7.2
  - setFurnitureVisiblePropertyNames
```
public void setFurnitureVisiblePropertyNames(java.util.List<java.lang.String> furnitureVisiblePropertyNames)
```
    Sets the furniture property names that are visible and the order in which they are visible, then fires a PropertyChangeEvent.
    
    Parameters:
    
    furnitureVisiblePropertyNames - the property names to display
    
    Since:
    
    7.2
  - getFurnitureVisibleProperties
```
public java.util.List<HomePieceOfFurniture.SortableProperty> getFurnitureVisibleProperties()
```
    Deprecated. getFurnitureVisibleProperties() and #setFurnitureVisibleProperties(List) should be replaced by calls to getFurnitureVisiblePropertyNames() and #setFurnitureSortedPropertyName(List) to allow displaying additional properties.
    
    Returns an unmodifiable list of the furniture properties that are visible.
  - setFurnitureVisibleProperties
```
public void setFurnitureVisibleProperties(java.util.List<HomePieceOfFurniture.SortableProperty> furnitureVisibleProperties)
```
    Deprecated. getFurnitureVisibleProperties() and #setFurnitureVisibleProperties(List) should be replaced by calls to getFurnitureVisiblePropertyNames() and #setFurnitureSortedPropertyName(List) to allow displaying additional properties.
    
    Sets the furniture properties that are visible and the order in which they are visible, then fires a PropertyChangeEvent.
    
    Parameters:
    
    furnitureVisibleProperties - the properties to display
  - getFurnitureAdditionalProperties
```
public java.util.List<ObjectProperty> getFurnitureAdditionalProperties()
```
    Returns the list of furniture additional properties which should be handled in the user interface.
    
    Since:
    
    7.2
  - setFurnitureAdditionalProperties
```
public void setFurnitureAdditionalProperties(java.util.List<ObjectProperty> furnitureAdditionalProperties)
```
    Sets the list of furniture additional properties which should be handled in the user interface.
    
    Since:
    
    7.2
  - getBackgroundImage
```
public BackgroundImage getBackgroundImage()
```
    Returns the plan background image of this home.
  - setBackgroundImage
```
public void setBackgroundImage(BackgroundImage backgroundImage)
```
    Sets the plan background image of this home and fires a PropertyChangeEvent.
    
    Parameters:
    
    backgroundImage - the new background image
  - getTopCamera
```
public Camera getTopCamera()
```
    Returns the camera used to display this home from a top point of view.
  - getObserverCamera
```
public ObserverCamera getObserverCamera()
```
    Returns the camera used to display this home from an observer point of view.
  - setCamera
```
public void setCamera(Camera camera)
```
    Sets the camera used to display this home and fires a PropertyChangeEvent.
    
    Parameters:
    
    camera - the camera to use
  - getCamera
```
public Camera getCamera()
```
    Returns the camera used to display this home.
  - setStoredCameras
```
public void setStoredCameras(java.util.List<Camera> storedCameras)
```
    Sets the cameras stored by this home and fires a PropertyChangeEvent. The list given as parameter is cloned but not the camera instances it contains.
    
    Parameters:
    
    storedCameras - the new list of cameras
    
    Since:
    
    3.0
  - getStoredCameras
```
public java.util.List<Camera> getStoredCameras()
```
    Returns an unmodifiable list of the cameras stored by this home.
    
    Since:
    
    3.0
  - getEnvironment
```
public HomeEnvironment getEnvironment()
```
    Returns the environment attributes of this home.
  - getCompass
```
public Compass getCompass()
```
    Returns the compass associated to this home.
    
    Since:
    
    3.0
  - getPrint
```
public HomePrint getPrint()
```
    Returns the print attributes of this home.
  - setPrint
```
public void setPrint(HomePrint print)
```
    Sets the print attributes of this home and fires a PropertyChangeEvent.
    
    Parameters:
    
    print - the new print attributes
  - getVisualProperty
```
public java.lang.Object getVisualProperty(java.lang.String name)
```
    Deprecated. getVisualProperty(String) and setVisualProperty(String, Object) should be replaced by calls to getProperty(String) and setProperty(String, String) to ensure they can be easily saved and read. Future file format might not save visual properties anymore.
    
    Returns the value of the visual property name associated with this home.
  - setVisualProperty
```
public void setVisualProperty(java.lang.String name,
                              java.lang.Object value)
```
    Deprecated. getVisualProperty(String) and setVisualProperty(String, Object) should be replaced by calls to getProperty(String) and setProperty(String, String) to ensure they can be easily saved and read. Future file format might not save visual properties anymore.
    
    Sets a visual property associated with this home.
  - getProperty
```
public java.lang.String getProperty(java.lang.String name)
```
    Returns the value of the property name associated with this home.
    
    Returns:
    
    the value of the property or null if it doesn't exist.
    
    Since:
    
    5.2
  - getNumericProperty
```
public java.lang.Number getNumericProperty(java.lang.String name)
```
    Returns the numeric value of the property name associated with this home.
    
    Returns:
    
    an instance of Long, Double or null if the property doesn't exist or can't be parsed.
    
    Since:
    
    5.2
  - setProperty
```
public void setProperty(java.lang.String name,
                        java.lang.String value)
```
    Sets a property associated with this home. Once the property is updated, listeners added to this home will receive a change event of PropertyChangeEvent class.
    To avoid any issue with existing or future properties of Sweet Home 3D classes, do not use property names written with only upper case letters.
    
    Parameters:
    
    name - the name of the property to set
    
    value - the new value of the property
    
    Since:
    
    5.2
  - getPropertyNames
```
public java.util.Collection<java.lang.String> getPropertyNames()
```
    Returns the property names.
    
    Returns:
    
    a collection of all the names of the properties set with setProperty
    
    Since:
    
    5.2
  - addPropertyChangeListener
```
public void addPropertyChangeListener(java.lang.String propertyName,
                                      java.beans.PropertyChangeListener listener)
```
    Adds the property change listener in parameter to this home for a specific property name. Properties set with setProperty will be notified with an event of PropertyChangeEvent class which property name will be equal to the property, whereas changes on properties of Home.Property enum will be notified with an event where the property name will be equal to the value returned by Enum.name() call.
    
    Since:
    
    6.4
  - removePropertyChangeListener
```
public void removePropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)
```
    Removes the property change listener in parameter from this object.
    
    Since:
    
    6.4
  - isBasePlanLocked
```
public boolean isBasePlanLocked()
```
    Returns true if the home objects belonging to the base plan (generally walls, rooms, dimension lines and texts) are locked.
    
    Since:
    
    1.8
  - setBasePlanLocked
```
public void setBasePlanLocked(boolean basePlanLocked)
```
    Sets whether home objects belonging to the base plan (generally walls, rooms, dimension lines and texts) are locked and fires a PropertyChangeEvent.
    
    Since:
    
    1.8
  - getVersion
```
public long getVersion()
```
    Returns the version of this home, the last time it was serialized or or CURRENT_VERSION if it is not serialized yet or was serialized with Sweet Home 3D 0.x. Version is useful to know with which Sweet Home 3D version this home was saved and warn user that he may lose information if he saves with current application a home created by a more recent version.
  - setVersion
```
public void setVersion(long version)
```
    Sets the version of this home.
    
    Since:
    
    5.2
  - clone
```
public Home clone()
```
    Returns a clone of this home and the objects it contains. Listeners bound to this home aren't added to the returned home.
    
    Overrides:
    
    clone in class java.lang.Object
    
    Since:
    
    2.3
  - duplicate
```
public static java.util.List<Selectable> duplicate(java.util.List<? extends Selectable> items)
```
    Returns a deep copy of home selectable items. Duplicated items are at the same index as their original and use different ids.
    
    Parameters:
    
    items - the items to duplicate
  - getFurnitureSubList
```
public static java.util.List<HomePieceOfFurniture> getFurnitureSubList(java.util.List<? extends Selectable> items)
```
    Returns a sub list of items that contains only home furniture.
    
    Parameters:
    
    items - the items among which the search is done
  - getWallsSubList
```
public static java.util.List<Wall> getWallsSubList(java.util.List<? extends Selectable> items)
```
    Returns a sub list of items that contains only walls.
    
    Parameters:
    
    items - the items among which the search is done
  - getRoomsSubList
```
public static java.util.List<Room> getRoomsSubList(java.util.List<? extends Selectable> items)
```
    Returns a sub list of items that contains only rooms.
    
    Parameters:
    
    items - the items among which the search is done
  - getPolylinesSubList
```
public static java.util.List<Polyline> getPolylinesSubList(java.util.List<? extends Selectable> items)
```
    Returns a sub list of items that contains only labels.
    
    Parameters:
    
    items - the items among which the search is done
    
    Since:
    
    5.0
  - getDimensionLinesSubList
```
public static java.util.List<DimensionLine> getDimensionLinesSubList(java.util.List<? extends Selectable> items)
```
    Returns a sub list of items that contains only dimension lines.
    
    Parameters:
    
    items - the items among which the search is done
  - getLabelsSubList
```
public static java.util.List<Label> getLabelsSubList(java.util.List<? extends Selectable> items)
```
    Returns a sub list of items that contains only labels.
    
    Parameters:
    
    items - the items among which the search is done
  - getSubList
```
public static <T> java.util.List<T> getSubList(java.util.List<? extends Selectable> items,
                                               java.lang.Class<T> subListClass)
```
    Returns a sub list of items that contains only instances of subListClass.
    
    Parameters:
    
    items - the items among which the search is done
    
    subListClass - the class of the searched items
    
    Since:
    
    2.2

Class Home

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CURRENT_VERSION

Constructor Detail

Home

Home

Home

Home

Method Detail

addLevelsListener

removeLevelsListener

getLevels

addLevel

deleteLevel

getSelectedLevel

setSelectedLevel

isAllLevelsSelection

setAllLevelsSelection

addFurnitureListener

removeFurnitureListener

getFurniture

addPieceOfFurniture

addPieceOfFurniture

addPieceOfFurnitureToGroup

deletePieceOfFurniture

addSelectionListener

removeSelectionListener

getSelectedItems

isItemSelected

setSelectedItems

deselectItem

addRoomsListener

removeRoomsListener

getRooms

addRoom

addRoom

deleteRoom

addWallsListener

removeWallsListener

getWalls

addWall

deleteWall

addPolylinesListener

removePolylinesListener

getPolylines

addPolyline

addPolyline

deletePolyline

addDimensionLinesListener

removeDimensionLinesListener

getDimensionLines

addDimensionLine

deleteDimensionLine

addLabelsListener

removeLabelsListener

getLabels

addLabel

deleteLabel

getSelectableViewableItems

getHomeObjects

isEmpty

addPropertyChangeListener

removePropertyChangeListener

getWallHeight

getName

setName

isModified

setModified

isRecovered

setRecovered

isRepaired

setRepaired

getFurnitureSortedPropertyName

setFurnitureSortedPropertyName

getFurnitureSortedProperty