org.openbase.bco.bcozy.view.pane.unit

Class AbstractUnitPane<UR extends org.openbase.bco.dal.lib.layer.unit.UnitRemote<D>,D extends com.google.protobuf.GeneratedMessage>

java.lang.Object

javafx.scene.Node

javafx.scene.Parent

javafx.scene.layout.Region

javafx.scene.layout.Pane

javafx.scene.layout.VBox

org.openbase.bco.bcozy.view.generic.WidgetPane

org.openbase.bco.bcozy.view.generic.ExpandableWidgedPane

org.openbase.bco.bcozy.view.pane.unit.AbstractUnitPane<UR,D>

Type Parameters:

UR - UnitRemote

D - Unit Data

All Implemented Interfaces:

javafx.css.Styleable, javafx.event.EventTarget, org.openbase.jul.iface.DefaultInitializable, org.openbase.jul.iface.Initializable<UR>, org.openbase.jul.iface.Shutdownable, org.openbase.jul.visual.javafx.iface.DynamicPane, org.openbase.jul.visual.javafx.iface.StaticPane

Direct Known Subclasses:

AgentPane, AppPane, BatteryPane, ColorableLightPane, DimmableLightPane, DimmableLightPane, LightPane, LightPane, LightSensorPane, LocationPane, MotionDetectorPane, PowerConsumptionSensorPane, PowerSwitchPane, ReedContactPane, RollerShutterPane, ScenePane, SmokeDetectorPane, TamperDetectorPane, TemperatureControllerPane, TemperatureSensorPane, UnitGroupPane

public abstract class AbstractUnitPane<UR extends org.openbase.bco.dal.lib.layer.unit.UnitRemote<D>,D extends com.google.protobuf.GeneratedMessage>
extends ExpandableWidgedPane
implements org.openbase.jul.iface.Initializable<UR>, org.openbase.jul.iface.Shutdownable

Created by divine on 25.04.17

Property Summary

Properties inherited from class org.openbase.bco.bcozy.view.generic.ExpandableWidgedPane

expansionProperty

Properties inherited from class org.openbase.bco.bcozy.view.generic.WidgetPane

primaryActivationProperty, secondaryActivationProperty

Properties inherited from class javafx.scene.layout.VBox

alignmentProperty, fillWidthProperty, spacingProperty

Properties inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, heightProperty, insetsProperty, maxHeightProperty, maxWidthProperty, minHeightProperty, minWidthProperty, opaqueInsetsProperty, paddingProperty, prefHeightProperty, prefWidthProperty, scaleShapeProperty, shapeProperty, snapToPixelProperty, widthProperty

Properties inherited from class javafx.scene.Parent

impl_traversalEngineProperty, needsLayoutProperty

Properties inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, cacheHintProperty, cacheProperty, clipProperty, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, focusedProperty, focusTraversableProperty, hoverProperty, idProperty, impl_showMnemonicsProperty, impl_treeVisibleProperty, inputMethodRequestsProperty, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParentTransformProperty, localToSceneTransformProperty, managedProperty, mouseTransparentProperty, nodeOrientationProperty, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, pickOnBoundsProperty, pressedProperty, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, styleProperty, translateXProperty, translateYProperty, translateZProperty, visibleProperty

Nested Class Summary

Nested classes/interfaces inherited from class org.openbase.bco.bcozy.view.generic.WidgetPane

WidgetPane.DisplayMode

Nested classes/interfaces inherited from interface org.openbase.jul.iface.Shutdownable

org.openbase.jul.iface.Shutdownable.ShutdownDeamon

Field Summary

Fields inherited from class org.openbase.bco.bcozy.view.generic.ExpandableWidgedPane

expansionProperty

Fields inherited from class org.openbase.bco.bcozy.view.generic.WidgetPane

LOGGER, primaryActivationProperty, secondaryActivationProperty

Fields inherited from class javafx.scene.layout.Region

USE_COMPUTED_SIZE, USE_PREF_SIZE

Fields inherited from class javafx.scene.Node

BASELINE_OFFSET_SAME_AS_HEIGHT

Constructor Summary

Constructors

Constructor and Description
AbstractUnitPane(Class<UR> unitRemoteClass, boolean activateable) Constructor for the UnitPane.

Method Summary

Modifier and Type	Method and Description
protected void	applyConfigUpdate(rst.domotic.unit.UnitConfigType.UnitConfig config) Notifies about unit data changes.
protected void	applyConnectionStateUpdate(org.openbase.jul.pattern.Remote.ConnectionState connectionState) Notifies about unit data changes.
protected void	applyDataUpdate(D data) Notifies about unit data changes.
protected void	applyLoginUpdate() Checks the permissions for the unit when the login state changes.
D	getData() Method returns the data object of the linked unit.
org.openbase.jul.visual.javafx.geometry.svg.SVGGlyphIcon	getIconSymbol() Returns a new Icon object according to the type of icon used in this class.
UR	getUnitRemote() Returns the UnitRemote.
String	getUnitStateDescription()
void	init(String unitId) Method initializes this pane with a unit referred by the given id.
void	init(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig) Method initializes this pane with a unit referred by the given id.
void	init(UR unitRemote) Method initializes this pane with the given unit remote.
void	initContent()
void	shutdown() Shutdown resets the remote observation.
String	toString() Method returns a unit pane description.

Methods inherited from class org.openbase.bco.bcozy.view.generic.ExpandableWidgedPane

expansionProperty, initBodyContent, updateDynamicContent

Methods inherited from class org.openbase.bco.bcozy.view.generic.WidgetPane

applyPrimaryActivationUpdate, getIcon, initHeadPane, primaryActivationProperty, secondaryActivationProperty, setDisplayMode, setIcon, setIcon, setInfoText, setLabel, setPrimaryActivationWithoutNotification, togglePrimaryActivation, toggleSecondaryActivation

Methods inherited from class javafx.scene.layout.VBox

alignmentProperty, clearConstraints, computeMinHeight, computeMinWidth, computePrefHeight, computePrefWidth, fillWidthProperty, getAlignment, getClassCssMetaData, getContentBias, getCssMetaData, getMargin, getSpacing, getVgrow, isFillWidth, layoutChildren, requestLayout, setAlignment, setFillWidth, setMargin, setSpacing, setVgrow, spacingProperty

Methods inherited from class javafx.scene.layout.Pane

getChildren

Methods inherited from class javafx.scene.layout.Region

backgroundProperty, borderProperty, cacheShapeProperty, centerShapeProperty, computeMaxHeight, computeMaxWidth, getBackground, getBorder, getHeight, getInsets, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpaqueInsets, getPadding, getPrefHeight, getPrefWidth, getShape, getUserAgentStylesheet, getWidth, heightProperty, impl_computeContains, impl_computeGeomBounds, impl_computeLayoutBounds, impl_createPeer, impl_notifyLayoutBoundsChanged, impl_pickNodeLocal, impl_updatePeer, insetsProperty, isCacheShape, isCenterShape, isResizable, isScaleShape, isSnapToPixel, layoutInArea, layoutInArea, layoutInArea, layoutInArea, maxHeight, maxHeightProperty, maxWidth, maxWidthProperty, minHeight, minHeightProperty, minWidth, minWidthProperty, opaqueInsetsProperty, paddingProperty, positionInArea, positionInArea, prefHeight, prefHeightProperty, prefWidth, prefWidthProperty, resize, scaleShapeProperty, setBackground, setBorder, setCacheShape, setCenterShape, setHeight, setMaxHeight, setMaxSize, setMaxWidth, setMinHeight, setMinSize, setMinWidth, setOpaqueInsets, setPadding, setPrefHeight, setPrefSize, setPrefWidth, setScaleShape, setShape, setSnapToPixel, setWidth, shapeProperty, snappedBottomInset, snappedLeftInset, snappedRightInset, snappedTopInset, snapPosition, snapSize, snapSpace, snapToPixelProperty, widthProperty

Methods inherited from class javafx.scene.Parent

getBaselineOffset, getChildrenUnmodifiable, getImpl_traversalEngine, getManagedChildren, getStylesheets, impl_getAllParentStylesheets, impl_processCSS, impl_processMXNode, impl_traversalEngineProperty, isNeedsLayout, layout, lookup, needsLayoutProperty, queryAccessibleAttribute, requestParentLayout, setImpl_traversalEngine, setNeedsLayout, updateBounds

Methods inherited from class javafx.scene.Node

accessibleHelpProperty, accessibleRoleDescriptionProperty, accessibleRoleProperty, accessibleTextProperty, addEventFilter, addEventHandler, applyCss, autosize, blendModeProperty, boundsInLocalProperty, boundsInParentProperty, buildEventDispatchChain, cacheHintProperty, cacheProperty, clipProperty, computeAreaInScreen, contains, contains, containsBounds, cursorProperty, depthTestProperty, disabledProperty, disableProperty, effectiveNodeOrientationProperty, effectProperty, eventDispatcherProperty, executeAccessibleAction, fireEvent, focusedProperty, focusTraversableProperty, getAccessibleHelp, getAccessibleRole, getAccessibleRoleDescription, getAccessibleText, getBlendMode, getBoundsInLocal, getBoundsInParent, getCacheHint, getClip, getCursor, getDepthTest, getEffect, getEffectiveNodeOrientation, getEventDispatcher, getId, getInputMethodRequests, getLayoutBounds, getLayoutX, getLayoutY, getLocalToParentTransform, getLocalToSceneTransform, getNodeOrientation, getOnContextMenuRequested, getOnDragDetected, getOnDragDone, getOnDragDropped, getOnDragEntered, getOnDragExited, getOnDragOver, getOnInputMethodTextChanged, getOnKeyPressed, getOnKeyReleased, getOnKeyTyped, getOnMouseClicked, getOnMouseDragEntered, getOnMouseDragExited, getOnMouseDragged, getOnMouseDragOver, getOnMouseDragReleased, getOnMouseEntered, getOnMouseExited, getOnMouseMoved, getOnMousePressed, getOnMouseReleased, getOnRotate, getOnRotationFinished, getOnRotationStarted, getOnScroll, getOnScrollFinished, getOnScrollStarted, getOnSwipeDown, getOnSwipeLeft, getOnSwipeRight, getOnSwipeUp, getOnTouchMoved, getOnTouchPressed, getOnTouchReleased, getOnTouchStationary, getOnZoom, getOnZoomFinished, getOnZoomStarted, getOpacity, getParent, getProperties, getPseudoClassStates, getRotate, getRotationAxis, getScaleX, getScaleY, getScaleZ, getScene, getStyle, getStyleableParent, getStyleClass, getTransforms, getTranslateX, getTranslateY, getTranslateZ, getTypeSelector, getUserData, hasProperties, hoverProperty, idProperty, impl_clearDirty, impl_computeIntersects, impl_cssGetCursorInitialValue, impl_cssGetFocusTraversableInitialValue, impl_findStyles, impl_geomChanged, impl_getLeafTransform, impl_getMatchingStyles, impl_getPeer, impl_getPivotX, impl_getPivotY, impl_getPivotZ, impl_getStyleMap, impl_hasTransforms, impl_intersects, impl_intersectsBounds, impl_isDirty, impl_isDirtyEmpty, impl_isShowMnemonics, impl_isTreeVisible, impl_layoutBoundsChanged, impl_markDirty, impl_pickNode, impl_processCSS, impl_reapplyCSS, impl_setShowMnemonics, impl_setStyleMap, impl_showMnemonicsProperty, impl_syncPeer, impl_transformsChanged, impl_traverse, impl_treeVisibleProperty, inputMethodRequestsProperty, intersects, intersects, isCache, isDisable, isDisabled, isFocused, isFocusTraversable, isHover, isManaged, isMouseTransparent, isPickOnBounds, isPressed, isVisible, layoutBoundsProperty, layoutXProperty, layoutYProperty, localToParent, localToParent, localToParent, localToParent, localToParent, localToParentTransformProperty, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToScene, localToSceneTransformProperty, localToScreen, localToScreen, localToScreen, localToScreen, localToScreen, lookupAll, managedProperty, mouseTransparentProperty, nodeOrientationProperty, notifyAccessibleAttributeChanged, onContextMenuRequestedProperty, onDragDetectedProperty, onDragDoneProperty, onDragDroppedProperty, onDragEnteredProperty, onDragExitedProperty, onDragOverProperty, onInputMethodTextChangedProperty, onKeyPressedProperty, onKeyReleasedProperty, onKeyTypedProperty, onMouseClickedProperty, onMouseDragEnteredProperty, onMouseDragExitedProperty, onMouseDraggedProperty, onMouseDragOverProperty, onMouseDragReleasedProperty, onMouseEnteredProperty, onMouseExitedProperty, onMouseMovedProperty, onMousePressedProperty, onMouseReleasedProperty, onRotateProperty, onRotationFinishedProperty, onRotationStartedProperty, onScrollFinishedProperty, onScrollProperty, onScrollStartedProperty, onSwipeDownProperty, onSwipeLeftProperty, onSwipeRightProperty, onSwipeUpProperty, onTouchMovedProperty, onTouchPressedProperty, onTouchReleasedProperty, onTouchStationaryProperty, onZoomFinishedProperty, onZoomProperty, onZoomStartedProperty, opacityProperty, parentProperty, parentToLocal, parentToLocal, parentToLocal, parentToLocal, parentToLocal, pickOnBoundsProperty, pressedProperty, pseudoClassStateChanged, relocate, removeEventFilter, removeEventHandler, requestFocus, resizeRelocate, rotateProperty, rotationAxisProperty, scaleXProperty, scaleYProperty, scaleZProperty, sceneProperty, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, sceneToLocal, screenToLocal, screenToLocal, screenToLocal, setAccessibleHelp, setAccessibleRole, setAccessibleRoleDescription, setAccessibleText, setBlendMode, setCache, setCacheHint, setClip, setCursor, setDepthTest, setDisable, setDisabled, setEffect, setEventDispatcher, setEventHandler, setFocused, setFocusTraversable, setHover, setId, setInputMethodRequests, setLayoutX, setLayoutY, setManaged, setMouseTransparent, setNodeOrientation, setOnContextMenuRequested, setOnDragDetected, setOnDragDone, setOnDragDropped, setOnDragEntered, setOnDragExited, setOnDragOver, setOnInputMethodTextChanged, setOnKeyPressed, setOnKeyReleased, setOnKeyTyped, setOnMouseClicked, setOnMouseDragEntered, setOnMouseDragExited, setOnMouseDragged, setOnMouseDragOver, setOnMouseDragReleased, setOnMouseEntered, setOnMouseExited, setOnMouseMoved, setOnMousePressed, setOnMouseReleased, setOnRotate, setOnRotationFinished, setOnRotationStarted, setOnScroll, setOnScrollFinished, setOnScrollStarted, setOnSwipeDown, setOnSwipeLeft, setOnSwipeRight, setOnSwipeUp, setOnTouchMoved, setOnTouchPressed, setOnTouchReleased, setOnTouchStationary, setOnZoom, setOnZoomFinished, setOnZoomStarted, setOpacity, setPickOnBounds, setPressed, setRotate, setRotationAxis, setScaleX, setScaleY, setScaleZ, setStyle, setTranslateX, setTranslateY, setTranslateZ, setUserData, setVisible, snapshot, snapshot, startDragAndDrop, startFullDrag, styleProperty, toBack, toFront, translateXProperty, translateYProperty, translateZProperty, usesMirroring, visibleProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openbase.jul.iface.Shutdownable

registerShutdownHook, registerShutdownHook

Methods inherited from interface org.openbase.jul.visual.javafx.iface.StaticPane

init

Constructor Detail

AbstractUnitPane

public AbstractUnitPane(Class<UR> unitRemoteClass,
                        boolean activateable)

Constructor for the UnitPane.

Parameters:

unitRemoteClass -

activateable -

Method Detail

init

public void init(String unitId)
          throws InterruptedException,
                 org.openbase.jul.exception.InitializationException

Method initializes this pane with a unit referred by the given id.

Parameters:

unitId - a unit id to init the pane.

Throws:

InterruptedException - is thrown if the current thread was externally interrupted.

org.openbase.jul.exception.InitializationException - is thrown if the initialization has been failed.

init

public void init(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig)
          throws InterruptedException,
                 org.openbase.jul.exception.InitializationException

Method initializes this pane with a unit referred by the given id.

Parameters:

unitConfig - a unit config to unit the pane.

Throws:

InterruptedException - is thrown if the current thread was externally interrupted.

org.openbase.jul.exception.InitializationException - is thrown if the initialization has been failed.

init

public void init(UR unitRemote)
          throws InterruptedException,
                 org.openbase.jul.exception.InitializationException

Method initializes this pane with the given unit remote.

Specified by:

init in interface org.openbase.jul.iface.Initializable<UR extends org.openbase.bco.dal.lib.layer.unit.UnitRemote<D>>

Parameters:

unitRemote - the unit remote.

Throws:

InterruptedException - is thrown if the current thread was externally interrupted.

org.openbase.jul.exception.InitializationException - is thrown if the initialization has been failed.

initContent

public void initContent()

Specified by:

initContent in interface org.openbase.jul.visual.javafx.iface.StaticPane

Overrides:

initContent in class ExpandableWidgedPane

getUnitRemote

public UR getUnitRemote()
                 throws org.openbase.jul.exception.NotAvailableException

Returns the UnitRemote.

Returns:

UnitRemote which is connected to these unit pane.

Throws:

org.openbase.jul.exception.NotAvailableException - if the pane is not connected to any unit remote.

getData

public D getData()
          throws org.openbase.jul.exception.NotAvailableException

Method returns the data object of the linked unit.

Returns:

the data object.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown if the data is currently not available.

getUnitStateDescription

public String getUnitStateDescription()
                               throws org.openbase.jul.exception.NotAvailableException

Throws:

org.openbase.jul.exception.NotAvailableException

shutdown

public void shutdown()

Shutdown resets the remote observation.

Specified by:

shutdown in interface org.openbase.jul.iface.Shutdownable

applyConfigUpdate

protected void applyConfigUpdate(rst.domotic.unit.UnitConfigType.UnitConfig config)
                          throws org.openbase.jul.exception.CouldNotPerformException

Notifies about unit data changes.

Parameters:

config -

Throws:

org.openbase.jul.exception.CouldNotPerformException

applyDataUpdate

protected void applyDataUpdate(D data)
                        throws org.openbase.jul.exception.CouldNotPerformException

Notifies about unit data changes.

Parameters:

data -

Throws:

org.openbase.jul.exception.CouldNotPerformException

applyConnectionStateUpdate

protected void applyConnectionStateUpdate(org.openbase.jul.pattern.Remote.ConnectionState connectionState)
                                   throws org.openbase.jul.exception.CouldNotPerformException

Notifies about unit data changes.

Parameters:

connectionState -

Throws:

org.openbase.jul.exception.CouldNotPerformException

applyLoginUpdate

protected void applyLoginUpdate()
                         throws org.openbase.jul.exception.CouldNotPerformException

Checks the permissions for the unit when the login state changes. Sets the disableProperty accordingly to the user's/client's write permissions.

Throws:

org.openbase.jul.exception.CouldNotPerformException

toString

public String toString()

Method returns a unit pane description.

Overrides:

toString in class javafx.scene.Node

Returns:

a description as string.

getIconSymbol

public org.openbase.jul.visual.javafx.geometry.svg.SVGGlyphIcon getIconSymbol()

Returns a new Icon object according to the type of icon used in this class.

Returns: