Package io.guise.framework.component

Class SliderControl<V extends java.lang.Number>

    • Field Detail

      • FLOW_PROPERTY

        public static final java.lang.String FLOW_PROPERTY
        The flow bound property.

      • INTERVAL_PROPERTY

        public static final java.lang.String INTERVAL_PROPERTY
        The interval step bound property.

      • SLIDING_PROPERTY

        public static final java.lang.String SLIDING_PROPERTY
        The bound property of the sliding state.

      • THUMB_X_IMAGE_PROPERTY

        public static final java.lang.String THUMB_X_IMAGE_PROPERTY
        The bound property of the horizontal thumb image.

      • THUMB_Y_IMAGE_PROPERTY

        public static final java.lang.String THUMB_Y_IMAGE_PROPERTY
        The bound property of the vertical thumb image.

      • TRACK_X_IMAGE_PROPERTY

        public static final java.lang.String TRACK_X_IMAGE_PROPERTY
        The bound property of the horizontal track image.

      • TRACK_Y_IMAGE_PROPERTY

        public static final java.lang.String TRACK_Y_IMAGE_PROPERTY
        The bound property of the vertical track image.

    • Constructor Detail

      • SliderControl

        public SliderControl​(java.lang.Class<V> valueClass,
                     Flow flow)
        Value class and flow constructor with a default data model to represent a given type and a default converter.
        Parameters:
        valueClass - The class indicating the type of value held in the model.
        flow - The flow along which the slider is oriented.
        Throws:
        java.lang.NullPointerException - if the value class and/or flow is null.

      • SliderControl

        public SliderControl​(java.lang.Class<V> valueClass,
                     Converter<V,​java.lang.String> converter,
                     Flow flow)
        Value class, converter and flow constructor with a default value model to represent a given type.
        Parameters:
        valueClass - The class indicating the type of value held in the model.
        converter - The string literal value converter for this component.
        flow - The flow along which the slider is oriented.
        Throws:
        java.lang.NullPointerException - if the given value class, converter, and/or flow is null.

      • SliderControl

        public SliderControl​(ValueModel<V> valueModel,
                     Flow flow)
        Value model and flow constructor with a default converter.
        Parameters:
        valueModel - The component value model.
        flow - The flow along which the slider is oriented.
        Throws:
        java.lang.NullPointerException - if the given value model and/or flow is null.
        java.lang.IllegalArgumentException - if no default converter is available for the given model's value class.

      • SliderControl

        public SliderControl​(ValueModel<V> valueModel,
                     Converter<V,​java.lang.String> converter,
                     Flow flow)
        Value model, converter, and flow constructor.
        Parameters:
        valueModel - The component value model.
        converter - The string literal value converter for this component.
        flow - The flow along which the slider is oriented.
        Throws:
        java.lang.NullPointerException - if the given value model, converter, and/or flow is null.

      • SliderControl

        public SliderControl​(ValuePrototype<V> valuePrototype,
                     Flow flow)
        Prototype and flow constructor.
        Parameters:
        valuePrototype - The prototype on which this component should be based.
        flow - The flow along which the slider is oriented.
        Throws:
        java.lang.NullPointerException - if the given prototype and/or flow is null.

    • Method Detail

      • getFlow

        public Flow getFlow()
        Returns:
        The flow along which the slider is oriented.

      • setFlow

        public void setFlow​(Flow newFlow)
        Sets the flow of the slider. This is a bound property
        Parameters:
        newFlow - The flow along which the slider is oriented.
        Throws:
        java.lang.NullPointerException - if the given flow is null.
        See Also:
        FLOW_PROPERTY

      • getConverter

        public Converter<V,​java.lang.String> getConverter()
        Returns:
        The converter for this component.

      • setConverter

        public void setConverter​(Converter<V,​java.lang.String> newConverter)
        Sets the converter. This is a bound property
        Parameters:
        newConverter - The converter for this component.
        Throws:
        java.lang.NullPointerException - if the given converter is null.
        See Also:
        ValueControl.CONVERTER_PROPERTY

      • getInterval

        public V getInterval()
        Returns:
        The value of the intervals, or null if a default interval should be used.

      • setInterval

        public void setInterval​(V newInterval)
                 throws ValidationException
        Sets the value of the intervals. This is a bound property.
        Parameters:
        newInterval - The new value of the intervals, or null if a default interval should be used.
        Throws:
        ValidationException - If the new interval is not valid.
        See Also:
        INTERVAL_PROPERTY

      • getThumbImage

        public java.net.URI getThumbImage​(Axis axis)
        Returns the thumb image for the indicated axis.
        Parameters:
        axis - The axis for which a thumb image should be returned.
        Returns:
        The thumb image for the given axis.

      • ThumbXImage

        public java.net.URI ThumbXImage()
        Returns the thumb image for the X axis.
        Returns:
        The thumb image for the indicated axis.

      • ThumbYImage

        public java.net.URI ThumbYImage()
        Returns the thumb image for the Y axis.
        Returns:
        The thumb image for the indicated axis.

      • setThumbImage

        public void setThumbImage​(Axis axis,
                          java.net.URI newThumbImage)
        Sets the thumb image for a given axis. The thumb image of each axis represents a bound property.
        Parameters:
        axis - The axis for which the thumb image should be set.
        newThumbImage - The thumb image.
        Throws:
        java.lang.NullPointerException - if the given axis and/or thumb image is null.
        See Also:
        THUMB_X_IMAGE_PROPERTY, THUMB_Y_IMAGE_PROPERTY

      • setThumbXImage

        public void setThumbXImage​(java.net.URI newThumbImage)
        Sets the thumb image for the X axis. This is a bound property.
        Parameters:
        newThumbImage - The thumb image.
        Throws:
        java.lang.NullPointerException - if the given thumb image is null.
        See Also:
        THUMB_X_IMAGE_PROPERTY

      • setThumbYImage

        public void setThumbYImage​(java.net.URI newThumbImage)
        Sets the thumb image for the Y axis. This is a bound property.
        Parameters:
        newThumbImage - The thumb image.
        Throws:
        java.lang.NullPointerException - if the given thumb image is null.
        See Also:
        THUMB_Y_IMAGE_PROPERTY

      • getTrackImage

        public java.net.URI getTrackImage​(Axis axis)
        Returns the track image for the indicated axis.
        Parameters:
        axis - The axis for which a track image should be returned.
        Returns:
        The track image for the given axis.

      • TrackXImage

        public java.net.URI TrackXImage()
        Returns the track image for the X axis.
        Returns:
        The track image for the indicated axis.

      • TrackYImage

        public java.net.URI TrackYImage()
        Returns the track image for the Y axis.
        Returns:
        The track image for the indicated axis.

      • setTrackImage

        public void setTrackImage​(Axis axis,
                          java.net.URI newTrackImage)
        Sets the track image for a given axis. The track image of each axis represents a bound property.
        Parameters:
        axis - The axis for which the track image should be set.
        newTrackImage - The track image.
        Throws:
        java.lang.NullPointerException - if the given axis and/or track image is null.
        See Also:
        TRACK_X_IMAGE_PROPERTY, TRACK_Y_IMAGE_PROPERTY

      • setTrackXImage

        public void setTrackXImage​(java.net.URI newTrackImage)
        Sets the track image for the X axis. This is a bound property.
        Parameters:
        newTrackImage - The track image.
        Throws:
        java.lang.NullPointerException - if the given track image is null.
        See Also:
        TRACK_X_IMAGE_PROPERTY

      • setTrackYImage

        public void setTrackYImage​(java.net.URI newTrackImage)
        Sets the track image for the Y axis. This is a bound property.
        Parameters:
        newTrackImage - The track image.
        Throws:
        java.lang.NullPointerException - if the given track image is null.
        See Also:
        TRACK_Y_IMAGE_PROPERTY

      • isSliding

        public boolean isSliding()
        Returns:
        Whether the slider is being slid.

      • setSliding

        public void setSliding​(boolean newSliding)
        Sets whether the slider is being slid. This is a bound property of type Boolean.
        Parameters:
        newSliding - true if the slider is sliding, else false.
        See Also:
        SLIDING_PROPERTY