com.mixer.interactive.resources.control

Class InteractiveControlPosition

java.lang.Object

com.mixer.interactive.resources.control.InteractiveControlPosition

All Implemented Interfaces:

Comparable<InteractiveControlPosition>

public class InteractiveControlPosition
extends Object
implements Comparable<InteractiveControlPosition>

A InteractiveControlPosition represents the position and size of the asociated control on the specified control canvas area.

Since:

1.0.0

Author:

Microsoft Corporation

Constructor Summary

Constructors

Constructor and Description
InteractiveControlPosition(InteractiveCanvasSize size) Initializes a new InteractiveControlPosition with default values.
InteractiveControlPosition(InteractiveCanvasSize size, int width, int height, int x, int y) Initializes a new InteractiveControlPosition.
InteractiveControlPosition(String size, int width, int height, int x, int y) Initializes a new InteractiveControlPosition.

Method Summary

Modifier and Type	Method and Description
int	compareTo(InteractiveControlPosition o)
boolean	equals(Object o)
InteractiveCanvasSize	getCanvasSize() Returns the InteractiveCanvasSize for this control position.
int	getHeight() Returns the InteractiveControls height for this control position.
int	getWidth() Returns the InteractiveControls width for this control position.
int	getX() Returns the InteractiveControls X position for this control position.
int	getY() Returns the InteractiveControls Y position for this control position.
int	hashCode()
InteractiveControlPosition	moveTo(int x, int y) Sets the InteractiveControls X and Y positions for this control position.
InteractiveControlPosition	resize(int width, int height) Sets the InteractiveControls height and width for this control position.
InteractiveControlPosition	setHeight(int height) Sets the InteractiveControls height for this control position.
InteractiveControlPosition	setWidth(int width) Sets the InteractiveControls width for this control position.
InteractiveControlPosition	setX(int x) Sets the InteractiveControls X position for this control position.
InteractiveControlPosition	setY(int y) Sets the InteractiveControls Y position for this control position.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

InteractiveControlPosition

public InteractiveControlPosition(InteractiveCanvasSize size)

Initializes a new InteractiveControlPosition with default values.

Parameters:

size - InteractiveCanvasSize for this InteractiveControlPosition

Since:

1.0.0

InteractiveControlPosition

public InteractiveControlPosition(String size,
                                  int width,
                                  int height,
                                  int x,
                                  int y)

Initializes a new InteractiveControlPosition.

Parameters:

size - Canvas size for this InteractiveControlPosition

width - Width of the InteractiveControl

height - Height of the InteractiveControl

x - X position on the Interactive control canvas

y - Y position on the Interactive control canvas

Since:

1.0.0

InteractiveControlPosition

public InteractiveControlPosition(InteractiveCanvasSize size,
                                  int width,
                                  int height,
                                  int x,
                                  int y)

Initializes a new InteractiveControlPosition.

Parameters:

size - InteractiveCanvasSize for this InteractiveControlPosition

width - Width of the InteractiveControl

height - Height of the InteractiveControl

x - X position on the Interactive control canvas

y - Y position on the Interactive control canvas

Since:

1.0.0

Method Detail

getCanvasSize

public InteractiveCanvasSize getCanvasSize()

Returns the InteractiveCanvasSize for this control position.

Returns:

InteractiveCanvasSize for this control position

Since:

1.0.0

getWidth

public int getWidth()

Returns the InteractiveControls width for this control position.

Returns:

The InteractiveControls width for this control position

Since:

1.0.0

setWidth

public InteractiveControlPosition setWidth(int width)

Sets the InteractiveControls width for this control position.

Parameters:

width - The InteractiveControls width for this control position

Returns:

this for method chaining

Since:

1.0.0

getHeight

public int getHeight()

Returns the InteractiveControls height for this control position.

Returns:

The InteractiveControls height for this control position

Since:

1.0.0

setHeight

public InteractiveControlPosition setHeight(int height)

Sets the InteractiveControls height for this control position.

Parameters:

height - The InteractiveControls height for this control position

Returns:

this for method chaining

Since:

1.0.0

resize

public InteractiveControlPosition resize(int width,
                                         int height)

Sets the InteractiveControls height and width for this control position.

Parameters:

width - The InteractiveControls height for this control position

height - The InteractiveControls height for this control position

Returns:

this for method chaining

Since:

1.0.0

getX

public int getX()

Returns the InteractiveControls X position for this control position.

Returns:

The InteractiveControls X position for this control position

Since:

1.0.0

setX

public InteractiveControlPosition setX(int x)

Sets the InteractiveControls X position for this control position.

Parameters:

x - The InteractiveControls X position for this control position

Returns:

this for method chaining

Since:

1.0.0

getY

public int getY()

Returns the InteractiveControls Y position for this control position.

Returns:

The InteractiveControls Y position for this control position

Since:

1.0.0

setY

public InteractiveControlPosition setY(int y)

Sets the InteractiveControls Y position for this control position.

Parameters:

y - The InteractiveControls Y position for this control position

Returns:

this for method chaining

Since:

1.0.0

moveTo

public InteractiveControlPosition moveTo(int x,
                                         int y)

Sets the InteractiveControls X and Y positions for this control position.

Parameters:

x - The InteractiveControls X position for this control position

y - The InteractiveControls Y position for this control position

Returns:

this for method chaining

Since:

1.0.0

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

1.0.0

compareTo

public int compareTo(InteractiveControlPosition o)

Specified by:

compareTo in interface Comparable<InteractiveControlPosition>

Since:

1.0.0

equals

public boolean equals(Object o)

Overrides:

equals in class Object

Since:

1.0.0