RoomController (Sweet Home 3D 7.5 API)

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

All Implemented Interfaces:

Controller
```
public class RoomController
extends java.lang.Object
implements Controller
```
A MVC controller for room view.

Author:

Emmanuel Puybaret

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`RoomController.Property` The properties that may be edited by the view associated to this controller.
`static class`	`RoomController.RoomPaint` The possible values for room paint type.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addPropertyChangeListener(RoomController.Property property, java.beans.PropertyChangeListener listener)` Adds the property change `listener` in parameter to this controller.
`void`	`displayView(View parentView)` Displays the view controlled by this controller.
`java.lang.Boolean`	`getAreaVisible()` Returns whether room area is visible or not.
`java.lang.Integer`	`getCeilingColor()` Returns the edited color of the ceiling.
`java.lang.Boolean`	`getCeilingFlat()` Returns whether room ceiling should remain flat whatever its environment or not.
`RoomController.RoomPaint`	`getCeilingPaint()` Returns whether the ceiling is colored, textured or unknown painted.
`java.lang.Float`	`getCeilingShininess()` Returns the edited shininess of the ceiling.
`TextureChoiceController`	`getCeilingTextureController()` Returns the texture controller of the room ceiling.
`java.lang.Boolean`	`getCeilingVisible()` Returns whether room ceiling is visible or not.
`java.lang.Integer`	`getFloorColor()` Returns the edited color of the floor.
`RoomController.RoomPaint`	`getFloorPaint()` Returns whether the floor is colored, textured or unknown painted.
`java.lang.Float`	`getFloorShininess()` Returns the edited shininess of the floor.
`TextureChoiceController`	`getFloorTextureController()` Returns the texture controller of the room floor.
`java.lang.Boolean`	`getFloorVisible()` Returns whether room floor is visible or not.
`java.lang.String`	`getName()` Returns the edited name.
`DialogView`	`getView()` Returns the view associated with this controller.
`BaseboardChoiceController`	`getWallSidesBaseboardController()` Returns the controller of the wall sides baseboard.
`java.lang.Integer`	`getWallSidesColor()` Returns the edited color of the wall sides.
`RoomController.RoomPaint`	`getWallSidesPaint()` Returns whether the wall sides are colored, textured or unknown painted.
`java.lang.Float`	`getWallSidesShininess()` Returns the edited shininess of the wall sides.
`TextureChoiceController`	`getWallSidesTextureController()` Returns the texture controller of the room wall sides.
`boolean`	`isPropertyEditable(RoomController.Property property)` Returns `true` if the given `property` is editable.
`boolean`	`isSplitSurroundingWalls()` Returns `true` if walls around the edited rooms should be split.
`boolean`	`isSplitSurroundingWallsNeeded()` Returns `true` if walls around the edited rooms need to be split to avoid changing the color of wall sides that belong to neighborhood rooms.
`void`	`modifyRooms()` Controls the modification of selected rooms in edited home.
`void`	`removePropertyChangeListener(RoomController.Property property, java.beans.PropertyChangeListener listener)` Removes the property change `listener` in parameter from this controller.
`void`	`setAreaVisible(java.lang.Boolean areaVisible)` Sets whether room area is visible or not.
`void`	`setCeilingColor(java.lang.Integer ceilingColor)` Sets the edited color of the ceiling.
`void`	`setCeilingFlat(java.lang.Boolean ceilingCeilingFlat)` Sets whether room ceiling should remain flat whatever its environment or not.
`void`	`setCeilingPaint(RoomController.RoomPaint ceilingPaint)` Sets whether the ceiling is colored, textured or unknown painted.
`void`	`setCeilingShininess(java.lang.Float ceilingShininess)` Sets the edited shininess of the ceiling.
`void`	`setCeilingVisible(java.lang.Boolean ceilingCeilingVisible)` Sets whether room ceiling is visible or not.
`void`	`setFloorColor(java.lang.Integer floorColor)` Sets the edited color of the floor.
`void`	`setFloorPaint(RoomController.RoomPaint floorPaint)` Sets whether the floor is colored, textured or unknown painted.
`void`	`setFloorShininess(java.lang.Float floorShininess)` Sets the edited shininess of the floor.
`void`	`setFloorVisible(java.lang.Boolean floorVisible)` Sets whether room floor is visible or not.
`void`	`setName(java.lang.String name)` Sets the edited name.
`void`	`setSplitSurroundingWalls(boolean splitSurroundingWalls)` Sets whether walls around the edited rooms should be split or not.
`void`	`setWallSidesColor(java.lang.Integer wallSidesColor)` Sets the edited color of the wall sides.
`void`	`setWallSidesPaint(RoomController.RoomPaint wallSidesPaint)` Sets whether the wall sides are colored, textured or unknown painted.
`void`	`setWallSidesShininess(java.lang.Float wallSidesShininess)` Sets the edited shininess of the wall sides.
`protected void`	`updateProperties()` Updates edited properties from selected rooms in the home edited by this controller.

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

- Constructor Detail
  - RoomController
```
public RoomController(Home home,
                      UserPreferences preferences,
                      ViewFactory viewFactory,
                      ContentManager contentManager,
                      javax.swing.undo.UndoableEditSupport undoSupport)
```
    Creates the controller of room view with undo support.
- Method Detail
  - getFloorTextureController
```
public TextureChoiceController getFloorTextureController()
```
    Returns the texture controller of the room floor.
  - getCeilingTextureController
```
public TextureChoiceController getCeilingTextureController()
```
    Returns the texture controller of the room ceiling.
  - getWallSidesTextureController
```
public TextureChoiceController getWallSidesTextureController()
```
    Returns the texture controller of the room wall sides.
  - getWallSidesBaseboardController
```
public BaseboardChoiceController getWallSidesBaseboardController()
```
    Returns the controller of the wall sides baseboard.
    
    Since:
    
    5.0
  - getView
```
public DialogView getView()
```
    Returns the view associated with this controller.
    
    Specified by:
    
    getView in interface Controller
  - displayView
```
public void displayView(View parentView)
```
    Displays the view controlled by this controller.
  - addPropertyChangeListener
```
public void addPropertyChangeListener(RoomController.Property property,
                                      java.beans.PropertyChangeListener listener)
```
    Adds the property change listener in parameter to this controller.
  - removePropertyChangeListener
```
public void removePropertyChangeListener(RoomController.Property property,
                                         java.beans.PropertyChangeListener listener)
```
    Removes the property change listener in parameter from this controller.
  - isPropertyEditable
```
public boolean isPropertyEditable(RoomController.Property property)
```
    Returns true if the given property is editable. Depending on whether a property is editable or not, the view associated to this controller may render it differently. The implementation of this method always returns true except for WALL properties.
  - updateProperties
```
protected void updateProperties()
```
    Updates edited properties from selected rooms in the home edited by this controller.
  - setName
```
public void setName(java.lang.String name)
```
    Sets the edited name.
  - getName
```
public java.lang.String getName()
```
    Returns the edited name.
  - setAreaVisible
```
public void setAreaVisible(java.lang.Boolean areaVisible)
```
    Sets whether room area is visible or not.
  - getAreaVisible
```
public java.lang.Boolean getAreaVisible()
```
    Returns whether room area is visible or not.
  - setFloorVisible
```
public void setFloorVisible(java.lang.Boolean floorVisible)
```
    Sets whether room floor is visible or not.
  - getFloorVisible
```
public java.lang.Boolean getFloorVisible()
```
    Returns whether room floor is visible or not.
  - setFloorColor
```
public void setFloorColor(java.lang.Integer floorColor)
```
    Sets the edited color of the floor.
  - getFloorColor
```
public java.lang.Integer getFloorColor()
```
    Returns the edited color of the floor.
  - setFloorPaint
```
public void setFloorPaint(RoomController.RoomPaint floorPaint)
```
    Sets whether the floor is colored, textured or unknown painted.
  - getFloorPaint
```
public RoomController.RoomPaint getFloorPaint()
```
    Returns whether the floor is colored, textured or unknown painted.
  - setFloorShininess
```
public void setFloorShininess(java.lang.Float floorShininess)
```
    Sets the edited shininess of the floor.
  - getFloorShininess
```
public java.lang.Float getFloorShininess()
```
    Returns the edited shininess of the floor.
  - setCeilingVisible
```
public void setCeilingVisible(java.lang.Boolean ceilingCeilingVisible)
```
    Sets whether room ceiling is visible or not.
  - getCeilingVisible
```
public java.lang.Boolean getCeilingVisible()
```
    Returns whether room ceiling is visible or not.
  - setCeilingColor
```
public void setCeilingColor(java.lang.Integer ceilingColor)
```
    Sets the edited color of the ceiling.
  - getCeilingColor
```
public java.lang.Integer getCeilingColor()
```
    Returns the edited color of the ceiling.
  - setCeilingPaint
```
public void setCeilingPaint(RoomController.RoomPaint ceilingPaint)
```
    Sets whether the ceiling is colored, textured or unknown painted.
  - getCeilingPaint
```
public RoomController.RoomPaint getCeilingPaint()
```
    Returns whether the ceiling is colored, textured or unknown painted.
  - setCeilingShininess
```
public void setCeilingShininess(java.lang.Float ceilingShininess)
```
    Sets the edited shininess of the ceiling.
  - getCeilingShininess
```
public java.lang.Float getCeilingShininess()
```
    Returns the edited shininess of the ceiling.
  - setCeilingFlat
```
public void setCeilingFlat(java.lang.Boolean ceilingCeilingFlat)
```
    Sets whether room ceiling should remain flat whatever its environment or not.
    
    Since:
    
    7.0
  - getCeilingFlat
```
public java.lang.Boolean getCeilingFlat()
```
    Returns whether room ceiling should remain flat whatever its environment or not.
    
    Since:
    
    7.0
  - isSplitSurroundingWalls
```
public boolean isSplitSurroundingWalls()
```
    Returns true if walls around the edited rooms should be split.
    
    Since:
    
    4.0
  - setSplitSurroundingWalls
```
public void setSplitSurroundingWalls(boolean splitSurroundingWalls)
```
    Sets whether walls around the edited rooms should be split or not.
    
    Since:
    
    4.0
  - isSplitSurroundingWallsNeeded
```
public boolean isSplitSurroundingWallsNeeded()
```
    Returns true if walls around the edited rooms need to be split to avoid changing the color of wall sides that belong to neighborhood rooms.
    
    Since:
    
    4.0
  - setWallSidesColor
```
public void setWallSidesColor(java.lang.Integer wallSidesColor)
```
    Sets the edited color of the wall sides.
    
    Since:
    
    4.0
  - getWallSidesColor
```
public java.lang.Integer getWallSidesColor()
```
    Returns the edited color of the wall sides.
    
    Since:
    
    4.0
  - setWallSidesPaint
```
public void setWallSidesPaint(RoomController.RoomPaint wallSidesPaint)
```
    Sets whether the wall sides are colored, textured or unknown painted.
    
    Since:
    
    4.0
  - getWallSidesPaint
```
public RoomController.RoomPaint getWallSidesPaint()
```
    Returns whether the wall sides are colored, textured or unknown painted.
    
    Since:
    
    4.0
  - setWallSidesShininess
```
public void setWallSidesShininess(java.lang.Float wallSidesShininess)
```
    Sets the edited shininess of the wall sides.
    
    Since:
    
    4.0
  - getWallSidesShininess
```
public java.lang.Float getWallSidesShininess()
```
    Returns the edited shininess of the wall sides.
    
    Since:
    
    4.0
  - modifyRooms
```
public void modifyRooms()
```
    Controls the modification of selected rooms in edited home.

Class RoomController

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RoomController

Method Detail

getFloorTextureController

getCeilingTextureController

getWallSidesTextureController

getWallSidesBaseboardController

getView

displayView

addPropertyChangeListener

removePropertyChangeListener

isPropertyEditable

updateProperties

setName

getName

setAreaVisible

getAreaVisible

setFloorVisible

getFloorVisible

setFloorColor

getFloorColor

setFloorPaint

getFloorPaint

setFloorShininess

getFloorShininess

setCeilingVisible

getCeilingVisible

setCeilingColor

getCeilingColor

setCeilingPaint

getCeilingPaint

setCeilingShininess

getCeilingShininess

setCeilingFlat

getCeilingFlat

isSplitSurroundingWalls

setSplitSurroundingWalls

isSplitSurroundingWallsNeeded

setWallSidesColor

getWallSidesColor

setWallSidesPaint

getWallSidesPaint

setWallSidesShininess

getWallSidesShininess

modifyRooms