Interface IStructureWithOpenStatus
- All Superinterfaces:
IPropertyHolder,IPropertyHolderConst
Represents an openable structure.
All structures that implement this interface need to register the Property.OPEN_STATUS property in their
structure type.
-
Method Summary
Modifier and TypeMethodDescriptiondefault booleanChecks if this structure can be closed right now.default booleanisOpen()Check if theStructureis currently open.default booleanChecks if this structure can be opened right now.default IPropertyValue<Boolean> Sets the structure to be closed.default IPropertyValue<Boolean> setOpen()Sets the structure to be open.default IPropertyValue<Boolean> setOpenStatus(boolean open) Sets the open status of the structure.Methods inherited from interface nl.pim16aap2.animatedarchitecture.core.structures.properties.IPropertyHolder
setPropertyValueMethods inherited from interface nl.pim16aap2.animatedarchitecture.core.structures.properties.IPropertyHolderConst
getPropertyValue, getRequiredPropertyValue, hasProperties, hasProperties, hasProperties, hasProperty
-
Method Details
-
isOpenable
default boolean isOpenable()Checks if this structure can be opened right now.- Returns:
- True if this structure can be opened right now.
-
isCloseable
default boolean isCloseable()Checks if this structure can be closed right now.- Returns:
- True if this structure can be closed right now.
-
isOpen
default boolean isOpen()Check if theStructureis currently open.- Returns:
- True if the
Structureis open
-
setOpenStatus
Sets the open status of the structure.- Parameters:
open- The new open status of the structure. True if the structure is open, false if it is closed.- Returns:
- The previous property value of the open status property.
-
setOpen
Sets the structure to be open.- Returns:
- The previous property value of the open status property.
-
setClosed
Sets the structure to be closed.- Returns:
- The previous property value of the open status property.
-