FurnitureController (Sweet Home 3D 7.5 API)

java.lang.Object
- com.eteks.sweethome3d.viewcontroller.FurnitureController

All Implemented Interfaces:

Controller

Direct Known Subclasses:

PlanController
```
public class FurnitureController
extends java.lang.Object
implements Controller
```
A MVC controller for the home furniture table.

Author:

Emmanuel Puybaret

Constructor Summary

Constructors
Constructor and Description
`FurnitureController(Home home, UserPreferences preferences, ViewFactory viewFactory)` Creates the controller of home furniture view.
`FurnitureController(Home home, UserPreferences preferences, ViewFactory viewFactory, ContentManager contentManager, javax.swing.undo.UndoableEditSupport undoSupport)` Creates the controller of home furniture view with undo support.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addFurniture(java.util.List<HomePieceOfFurniture> furniture)` Controls new furniture added to home.
`void`	`addFurniture(java.util.List<HomePieceOfFurniture> furniture, HomePieceOfFurniture beforePiece)` Controls new furniture added to home.
`void`	`addFurnitureToGroup(java.util.List<HomePieceOfFurniture> furniture, HomeFurnitureGroup group)` Controls new furniture added to the given group.
`void`	`alignSelectedFurnitureOnBackSide()` Controls the alignment of selected furniture on the back side of the first selected piece.
`void`	`alignSelectedFurnitureOnBottom()` Controls the alignment of selected furniture on bottom of the first selected piece.
`void`	`alignSelectedFurnitureOnFrontSide()` Controls the alignment of selected furniture on the front side of the first selected piece.
`void`	`alignSelectedFurnitureOnLeft()` Controls the alignment of selected furniture on left of the first selected piece.
`void`	`alignSelectedFurnitureOnLeftSide()` Controls the alignment of selected furniture on the left side of the first selected piece.
`void`	`alignSelectedFurnitureOnRight()` Controls the alignment of selected furniture on right of the first selected piece.
`void`	`alignSelectedFurnitureOnRightSide()` Controls the alignment of selected furniture on the right side of the first selected piece.
`void`	`alignSelectedFurnitureOnTop()` Controls the alignment of selected furniture on top of the first selected piece.
`void`	`alignSelectedFurnitureSideBySide()` Controls the alignment of selected furniture on the sides of the first selected piece.
`protected HomeFurnitureGroup`	`createHomeFurnitureGroup(java.util.List<HomePieceOfFurniture> furniture)` Returns a new furniture group for the given furniture list.
`protected HomeFurnitureGroup`	`createHomeFurnitureGroup(java.util.List<HomePieceOfFurniture> furniture, HomePieceOfFurniture leadingPiece)` Returns a new furniture group for the given furniture list.
`HomePieceOfFurniture`	`createHomePieceOfFurniture(PieceOfFurniture piece)` Returns a new home piece of furniture created from an other given `piece` of furniture.
`void`	`deleteFurniture(java.util.List<HomePieceOfFurniture> deletedFurniture)` Deletes the furniture of `deletedFurniture` from home.
`void`	`deleteSelection()` Controls the deletion of the current selected furniture in home.
`void`	`distributeSelectedFurniture(boolean horizontal)` Controls the distribution of the selected furniture along the axis orthogonal to the given one.
`void`	`distributeSelectedFurnitureHorizontally()` Controls the distribution of the selected furniture along horizontal axis.
`void`	`distributeSelectedFurnitureVertically()` Controls the distribution of the selected furniture along vertical axis.
`protected java.util.List<HomePieceOfFurniture>`	`getFurnitureInSameGroup(HomePieceOfFurniture piece)` Returns the furniture list of the given `piece` which belongs to same group or home furniture if it doesn't belong to home furniture.
`protected HomePieceOfFurniture`	`getHighestSurroundingPieceOfFurniture(HomePieceOfFurniture piece)` Returns the highest piece of furniture that includes the given `piece` with a margin error of 5% of the smallest side length.
`protected java.util.List<HomePieceOfFurniture>`	`getSurroundingFurniture(HomePieceOfFurniture piece)` Returns the shelf units which include the given `piece` with a margin error of 20% of the smallest side length.
`View`	`getView()` Returns the view associated with this controller.
`void`	`groupSelectedFurniture()` Groups the selected furniture as one piece of furniture.
`void`	`importFurniture()` Displays the wizard that helps to import furniture to home.
`void`	`importFurniture(java.lang.String modelName)` Displays the wizard that helps to import furniture to home with a given model name.
`protected boolean`	`isPieceOfFurnitureDeletable(HomePieceOfFurniture piece)` Returns `true` if the given `piece` may be deleted.
`protected boolean`	`isPieceOfFurnitureMovable(HomePieceOfFurniture piece)` Returns `true` if the given `piece` may be moved.
`protected boolean`	`isPieceOfFurniturePartOfBasePlan(HomePieceOfFurniture piece)` Returns `true` if the given `piece` isn't movable.
`protected boolean`	`isPieceOfFurnitureVisibleAtSelectedLevel(HomePieceOfFurniture piece)` Returns `true` if the given piece is viewable and its height and elevation make it viewable at the selected level in home.
`void`	`modifySelectedFurniture()` Controls the modification of selected furniture.
`void`	`moveSelectedFurnitureBefore(HomePieceOfFurniture beforePiece)` Reorders the selected furniture in home to place it before the given piece.
`void`	`resetFurnitureElevation()` Resets the elevation of the selected furniture to its default elevation.
`void`	`selectAll()` Selects all furniture in home.
`void`	`setFurnitureVisibleProperties(java.util.List<HomePieceOfFurniture.SortableProperty> furnitureVisibleProperties)` Deprecated. `#setFurnitureVisibleProperties(List)` should be replaced by calls to `#setFurnitureVisiblePropertyNames(List)` to allow displaying additional properties.
`void`	`setFurnitureVisiblePropertyNames(java.util.List<java.lang.String> furnitureVisiblePropertyNames)` Updates the furniture visible properties in home.
`void`	`setHomeProperty(java.lang.String propertyName, java.lang.String propertyValue)` Controls the change of value of a property in home.
`void`	`setSelectedFurniture(java.util.List<HomePieceOfFurniture> selectedFurniture)` Updates the selected furniture in home.
`void`	`setSelectedFurniture(java.util.List<HomePieceOfFurniture> selectedFurniture, boolean resetSelection)` Updates the selected furniture in home, unselecting all other kinds of selected objects when `resetSelection` is `true`.
`void`	`setVisualProperty(java.lang.String propertyName, java.lang.Object propertyValue)` Deprecated. `setVisualProperty` should be replaced by a call to `setHomeProperty(String, String)` to ensure the property can be easily saved and read.
`void`	`sortFurniture(HomePieceOfFurniture.SortableProperty furnitureProperty)` Deprecated. `sortFurniture(HomePieceOfFurniture.SortableProperty)` should be replaced by calls to `sortFurniture(String)` to allow displaying additional properties.
`void`	`sortFurniture(java.lang.String furniturePropertyName)` Controls the sort of the furniture in home.
`void`	`toggleFurnitureSort(HomePieceOfFurniture.SortableProperty furnitureProperty)` Deprecated. `toggleFurnitureSort(HomePieceOfFurniture.SortableProperty)` should be replaced by calls to `toggleFurnitureSort(String)` to allow displaying additional properties.
`void`	`toggleFurnitureSort(java.lang.String furniturePropertyName)` Uses `furniturePropertyName` to sort home furniture or cancels home furniture sort if home is already sorted on `furnitureProperty`
`void`	`toggleFurnitureSortOrder()` Toggles home furniture sort order.
`void`	`toggleFurnitureVisibleProperty(HomePieceOfFurniture.SortableProperty furnitureProperty)` Deprecated. `toggleFurnitureVisibleProperty(HomePieceOfFurniture.SortableProperty)` should be replaced by calls to `toggleFurnitureVisibleProperty(String)` to allow displaying additional properties.
`void`	`toggleFurnitureVisibleProperty(java.lang.String furniturePropertyName)` Toggles furniture property visibility in home.
`void`	`toggleSelectedFurnitureVisibility()` Controls the modification of the visibility of the selected piece of furniture.
`void`	`ungroupSelectedFurniture()` Ungroups the selected groups of furniture.

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

- Constructor Detail
  - FurnitureController
```
public FurnitureController(Home home,
                           UserPreferences preferences,
                           ViewFactory viewFactory)
```
    Creates the controller of home furniture view.
    
    Parameters:
    
    home - the home edited by this controller and its view
    
    preferences - the preferences of the application
    
    viewFactory - a factory able to create the furniture view managed by this controller
  - FurnitureController
```
public FurnitureController(Home home,
                           UserPreferences preferences,
                           ViewFactory viewFactory,
                           ContentManager contentManager,
                           javax.swing.undo.UndoableEditSupport undoSupport)
```
    Creates the controller of home furniture view with undo support.
- Method Detail
  - getView
```
public View getView()
```
    Returns the view associated with this controller.
    
    Specified by:
    
    getView in interface Controller
  - addFurniture
```
public void addFurniture(java.util.List<HomePieceOfFurniture> furniture)
```
    Controls new furniture added to home. Once added the furniture will be selected in view and undo support will receive a new undoable edit.
    
    Parameters:
    
    furniture - the furniture to add.
  - addFurniture
```
public void addFurniture(java.util.List<HomePieceOfFurniture> furniture,
                         HomePieceOfFurniture beforePiece)
```
    Controls new furniture added to home. Once added the furniture will be selected in view and undo support will receive a new undoable edit.
    
    Parameters:
    
    furniture - the furniture to add.
    
    beforePiece - the piece before which the furniture will be added
    
    Since:
    
    6.3
  - addFurnitureToGroup
```
public void addFurnitureToGroup(java.util.List<HomePieceOfFurniture> furniture,
                                HomeFurnitureGroup group)
```
    Controls new furniture added to the given group. Once added the furniture will be selected in view and undo support will receive a new undoable edit.
    
    Parameters:
    
    furniture - the furniture to add.
    
    group - the group to which furniture will be added.
  - deleteSelection
```
public void deleteSelection()
```
    Controls the deletion of the current selected furniture in home. Once the selected furniture is deleted, undo support will receive a new undoable edit.
  - deleteFurniture
```
public void deleteFurniture(java.util.List<HomePieceOfFurniture> deletedFurniture)
```
    Deletes the furniture of deletedFurniture from home. Once the selected furniture is deleted, undo support will receive a new undoable edit.
  - moveSelectedFurnitureBefore
```
public void moveSelectedFurnitureBefore(HomePieceOfFurniture beforePiece)
```
    Reorders the selected furniture in home to place it before the given piece.
    
    Since:
    
    6.3
  - setSelectedFurniture
```
public void setSelectedFurniture(java.util.List<HomePieceOfFurniture> selectedFurniture)
```
    Updates the selected furniture in home.
  - setSelectedFurniture
```
public void setSelectedFurniture(java.util.List<HomePieceOfFurniture> selectedFurniture,
                                 boolean resetSelection)
```
    Updates the selected furniture in home, unselecting all other kinds of selected objects when resetSelection is true.
    
    Since:
    
    6.1
  - selectAll
```
public void selectAll()
```
    Selects all furniture in home.
  - isPieceOfFurniturePartOfBasePlan
```
protected boolean isPieceOfFurniturePartOfBasePlan(HomePieceOfFurniture piece)
```
    Returns true if the given piece isn't movable.
  - isPieceOfFurnitureMovable
```
protected boolean isPieceOfFurnitureMovable(HomePieceOfFurniture piece)
```
    Returns true if the given piece may be moved. Default implementation always returns true.
  - isPieceOfFurnitureDeletable
```
protected boolean isPieceOfFurnitureDeletable(HomePieceOfFurniture piece)
```
    Returns true if the given piece may be deleted. Default implementation always returns true.
  - createHomePieceOfFurniture
```
public HomePieceOfFurniture createHomePieceOfFurniture(PieceOfFurniture piece)
```
    Returns a new home piece of furniture created from an other given piece of furniture.
  - toggleFurnitureSort
```
public void toggleFurnitureSort(java.lang.String furniturePropertyName)
```
    Uses furniturePropertyName to sort home furniture or cancels home furniture sort if home is already sorted on furnitureProperty
    
    Parameters:
    
    furniturePropertyName - a property of HomePieceOfFurniture class.
    
    Since:
    
    7.2
  - toggleFurnitureSort
```
public void toggleFurnitureSort(HomePieceOfFurniture.SortableProperty furnitureProperty)
```
    Deprecated. toggleFurnitureSort(HomePieceOfFurniture.SortableProperty) should be replaced by calls to toggleFurnitureSort(String) to allow displaying additional properties.
    
    Uses furnitureProperty to sort home furniture or cancels home furniture sort if home is already sorted on furnitureProperty
    
    Parameters:
    
    furnitureProperty - a property of HomePieceOfFurniture class.
  - toggleFurnitureSortOrder
```
public void toggleFurnitureSortOrder()
```
    Toggles home furniture sort order.
  - sortFurniture
```
public void sortFurniture(java.lang.String furniturePropertyName)
```
    Controls the sort of the furniture in home. If home furniture isn't sorted or is sorted on an other property, it will be sorted on the given furnitureProperty in ascending order. If home furniture is already sorted on the given furnitureProperty, it will be sorted in descending order, if the sort is in ascending order, otherwise it won't be sorted at all and home furniture will be listed in insertion order.
    
    Parameters:
    
    furniturePropertyName - the furniture property on which the view wants to sort the furniture it displays.
    
    Since:
    
    7.2
  - sortFurniture
```
public void sortFurniture(HomePieceOfFurniture.SortableProperty furnitureProperty)
```
    Deprecated. sortFurniture(HomePieceOfFurniture.SortableProperty) should be replaced by calls to sortFurniture(String) to allow displaying additional properties.
    
    Controls the sort of the furniture in home.
    
    Parameters:
    
    furnitureProperty - the furniture property on which the view wants to sort the furniture it displays.
  - setFurnitureVisiblePropertyNames
```
public void setFurnitureVisiblePropertyNames(java.util.List<java.lang.String> furnitureVisiblePropertyNames)
```
    Updates the furniture visible properties in home.
  - setFurnitureVisibleProperties
```
public void setFurnitureVisibleProperties(java.util.List<HomePieceOfFurniture.SortableProperty> furnitureVisibleProperties)
```
    Deprecated. #setFurnitureVisibleProperties(List) should be replaced by calls to #setFurnitureVisiblePropertyNames(List) to allow displaying additional properties.
    
    Updates the furniture visible properties in home.
  - toggleFurnitureVisibleProperty
```
public void toggleFurnitureVisibleProperty(java.lang.String furniturePropertyName)
```
    Toggles furniture property visibility in home.
    
    Since:
    
    7.2
  - toggleFurnitureVisibleProperty
```
public void toggleFurnitureVisibleProperty(HomePieceOfFurniture.SortableProperty furnitureProperty)
```
    Deprecated. toggleFurnitureVisibleProperty(HomePieceOfFurniture.SortableProperty) should be replaced by calls to toggleFurnitureVisibleProperty(String) to allow displaying additional properties.
    
    Toggles furniture property visibility in home.
  - modifySelectedFurniture
```
public void modifySelectedFurniture()
```
    Controls the modification of selected furniture.
  - toggleSelectedFurnitureVisibility
```
public void toggleSelectedFurnitureVisibility()
```
    Controls the modification of the visibility of the selected piece of furniture.
  - groupSelectedFurniture
```
public void groupSelectedFurniture()
```
    Groups the selected furniture as one piece of furniture.
  - createHomeFurnitureGroup
```
protected HomeFurnitureGroup createHomeFurnitureGroup(java.util.List<HomePieceOfFurniture> furniture)
```
    Returns a new furniture group for the given furniture list.
  - createHomeFurnitureGroup
```
protected HomeFurnitureGroup createHomeFurnitureGroup(java.util.List<HomePieceOfFurniture> furniture,
                                                      HomePieceOfFurniture leadingPiece)
```
    Returns a new furniture group for the given furniture list.
    
    Since:
    
    4.5
  - ungroupSelectedFurniture
```
public void ungroupSelectedFurniture()
```
    Ungroups the selected groups of furniture.
  - importFurniture
```
public void importFurniture()
```
    Displays the wizard that helps to import furniture to home.
  - importFurniture
```
public void importFurniture(java.lang.String modelName)
```
    Displays the wizard that helps to import furniture to home with a given model name.
  - alignSelectedFurnitureOnTop
```
public void alignSelectedFurnitureOnTop()
```
    Controls the alignment of selected furniture on top of the first selected piece.
  - alignSelectedFurnitureOnBottom
```
public void alignSelectedFurnitureOnBottom()
```
    Controls the alignment of selected furniture on bottom of the first selected piece.
  - alignSelectedFurnitureOnLeft
```
public void alignSelectedFurnitureOnLeft()
```
    Controls the alignment of selected furniture on left of the first selected piece.
  - alignSelectedFurnitureOnRight
```
public void alignSelectedFurnitureOnRight()
```
    Controls the alignment of selected furniture on right of the first selected piece.
  - alignSelectedFurnitureOnFrontSide
```
public void alignSelectedFurnitureOnFrontSide()
```
    Controls the alignment of selected furniture on the front side of the first selected piece.
  - alignSelectedFurnitureOnBackSide
```
public void alignSelectedFurnitureOnBackSide()
```
    Controls the alignment of selected furniture on the back side of the first selected piece.
  - alignSelectedFurnitureOnLeftSide
```
public void alignSelectedFurnitureOnLeftSide()
```
    Controls the alignment of selected furniture on the left side of the first selected piece.
  - alignSelectedFurnitureOnRightSide
```
public void alignSelectedFurnitureOnRightSide()
```
    Controls the alignment of selected furniture on the right side of the first selected piece.
  - alignSelectedFurnitureSideBySide
```
public void alignSelectedFurnitureSideBySide()
```
    Controls the alignment of selected furniture on the sides of the first selected piece.
  - distributeSelectedFurnitureHorizontally
```
public void distributeSelectedFurnitureHorizontally()
```
    Controls the distribution of the selected furniture along horizontal axis.
  - distributeSelectedFurnitureVertically
```
public void distributeSelectedFurnitureVertically()
```
    Controls the distribution of the selected furniture along vertical axis.
  - distributeSelectedFurniture
```
public void distributeSelectedFurniture(boolean horizontal)
```
    Controls the distribution of the selected furniture along the axis orthogonal to the given one.
  - resetFurnitureElevation
```
public void resetFurnitureElevation()
```
    Resets the elevation of the selected furniture to its default elevation.
    
    Since:
    
    4.4
  - getHighestSurroundingPieceOfFurniture
```
protected HomePieceOfFurniture getHighestSurroundingPieceOfFurniture(HomePieceOfFurniture piece)
```
    Returns the highest piece of furniture that includes the given piece with a margin error of 5% of the smallest side length.
    
    Since:
    
    4.4
  - getSurroundingFurniture
```
protected java.util.List<HomePieceOfFurniture> getSurroundingFurniture(HomePieceOfFurniture piece)
```
    Returns the shelf units which include the given piece with a margin error of 20% of the smallest side length.
    
    Since:
    
    7.2
  - getFurnitureInSameGroup
```
protected java.util.List<HomePieceOfFurniture> getFurnitureInSameGroup(HomePieceOfFurniture piece)
```
    Returns the furniture list of the given piece which belongs to same group or home furniture if it doesn't belong to home furniture.
    
    Since:
    
    5.0
  - isPieceOfFurnitureVisibleAtSelectedLevel
```
protected boolean isPieceOfFurnitureVisibleAtSelectedLevel(HomePieceOfFurniture piece)
```
    Returns true if the given piece is viewable and its height and elevation make it viewable at the selected level in home.
    
    Since:
    
    4.4
  - setVisualProperty
```
public void setVisualProperty(java.lang.String propertyName,
                              java.lang.Object propertyValue)
```
    Deprecated. setVisualProperty should be replaced by a call to setHomeProperty(String, String) to ensure the property can be easily saved and read.
    
    Controls the change of value of a visual property in home.
    
    Since:
    
    5.0
  - setHomeProperty
```
public void setHomeProperty(java.lang.String propertyName,
                            java.lang.String propertyValue)
```
    Controls the change of value of a property in home.
    
    Since:
    
    5.2

Class FurnitureController

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FurnitureController

FurnitureController

Method Detail

getView

addFurniture

addFurniture

addFurnitureToGroup

deleteSelection

deleteFurniture

moveSelectedFurnitureBefore

setSelectedFurniture

setSelectedFurniture

selectAll

isPieceOfFurniturePartOfBasePlan

isPieceOfFurnitureMovable

isPieceOfFurnitureDeletable

createHomePieceOfFurniture

toggleFurnitureSort

toggleFurnitureSort

toggleFurnitureSortOrder

sortFurniture

sortFurniture

setFurnitureVisiblePropertyNames

setFurnitureVisibleProperties

toggleFurnitureVisibleProperty

toggleFurnitureVisibleProperty

modifySelectedFurniture

toggleSelectedFurnitureVisibility

groupSelectedFurniture

createHomeFurnitureGroup

createHomeFurnitureGroup

ungroupSelectedFurniture

importFurniture

importFurniture

alignSelectedFurnitureOnTop

alignSelectedFurnitureOnBottom

alignSelectedFurnitureOnLeft

alignSelectedFurnitureOnRight

alignSelectedFurnitureOnFrontSide

alignSelectedFurnitureOnBackSide

alignSelectedFurnitureOnLeftSide

alignSelectedFurnitureOnRightSide

alignSelectedFurnitureSideBySide

distributeSelectedFurnitureHorizontally

distributeSelectedFurnitureVertically

distributeSelectedFurniture

resetFurnitureElevation

getHighestSurroundingPieceOfFurniture

getSurroundingFurniture

getFurnitureInSameGroup

isPieceOfFurnitureVisibleAtSelectedLevel

setVisualProperty

setHomeProperty