FMLiveSwitchLayoutFrame Class Reference

A layout frame definition, including X/Y coordinates and width/height values. More...

Instance Methods
(NSString *)	- clientId
	Gets the client identifier. More...
(NSString *)	- deviceId
	Gets the device identifier. More...
(int)	- height
	Gets the height value. More...
(instancetype)	- initWithX:y:width:height:
	Initializes a new instance of the FMLiveSwitchLayoutFrame class. More...
(bool)	- isEquivalentWithLayoutFrame:
	Determines whether the specified layout frame is equivalent. More...
(int)	- orientation
	Gets the orientation in degrees. More...
(void)	- setClientId:
	Sets the client identifier. More...
(void)	- setDeviceId:
	Sets the device identifier. More...
(void)	- setHeight:
	Sets the height value. More...
(void)	- setOrientation:
	Sets the orientation in degrees. More...
(void)	- setUserId:
	Sets the user identifier. More...
(void)	- setViewId:
	Sets the view ID. More...
(void)	- setWidth:
	Sets the width value. More...
(void)	- setX:
	Sets the X coordinate. More...
(void)	- setY:
	Sets the Y coordinate. More...
(NSString *)	- toJson
	Serializes this instance to JSON. More...
(NSString *)	- userId
	Gets the user identifier. More...
(NSString *)	- viewId
	Gets the view ID. More...
(int)	- width
	Gets the width value. More...
(int)	- x
	Gets the X coordinate. More...
(int)	- y
	Gets the Y coordinate. More...

Class Methods
(FMLiveSwitchLayoutFrame *)	+ fromJsonWithLayoutFrameJson:
	Deserializes a layout frame from JSON. More...
(FMLiveSwitchLayoutFrame *)	+ getScaledFrameWithScale:outerWidth:outerHeight:innerWidth:innerHeight:
	Gets a scaled frame. More...
(FMLiveSwitchLayoutFrame *)	+ layoutFrameWithX:y:width:height:
	Initializes a new instance of the FMLiveSwitchLayoutFrame class. More...
(NSString *)	+ toJsonWithLayoutFrame:
	Serializes a layout frame to JSON. More...

Detailed Description

A layout frame definition, including X/Y coordinates and width/height values.

Method Documentation

clientId

- (NSString*) clientId

Gets the client identifier.

deviceId

- (NSString*) deviceId

Gets the device identifier.

fromJsonWithLayoutFrameJson:

+ (FMLiveSwitchLayoutFrame*) fromJsonWithLayoutFrameJson:

(NSString *)

layoutFrameJson

Deserializes a layout frame from JSON.

Parameters

layoutFrameJson

The layout frame JSON.

getScaledFrameWithScale:outerWidth:outerHeight:innerWidth:innerHeight:

+ (FMLiveSwitchLayoutFrame*) getScaledFrameWithScale:		(FMLiveSwitchLayoutScale)	scale
outerWidth:		(int)	outerWidth
outerHeight:		(int)	outerHeight
innerWidth:		(int)	innerWidth
innerHeight:		(int)	innerHeight

Gets a scaled frame.

Parameters

scale	The scaling algorithm to use.
outerWidth	The width of the outer container.
outerHeight	The height of the outer container.
innerWidth	The width of the inner element.
innerHeight	The height of the inner element.

height

- (int) height

Gets the height value.

initWithX:y:width:height:

- (instancetype) initWithX:		(int)	x
y:		(int)	y
width:		(int)	width
height:		(int)	height

Initializes a new instance of the FMLiveSwitchLayoutFrame class.

Parameters

x	The X coordinate.
y	The Y coordinate.
width	The width value.
height	The height value.

isEquivalentWithLayoutFrame:

- (bool) isEquivalentWithLayoutFrame:

(FMLiveSwitchLayoutFrame *)

layoutFrame

Determines whether the specified layout frame is equivalent.

Parameters

layoutFrame

The layout frame.

layoutFrameWithX:y:width:height:

+ (FMLiveSwitchLayoutFrame*) layoutFrameWithX:		(int)	x
y:		(int)	y
width:		(int)	width
height:		(int)	height

Initializes a new instance of the FMLiveSwitchLayoutFrame class.

Parameters

x	The X coordinate.
y	The Y coordinate.
width	The width value.
height	The height value.

orientation

- (int) orientation

Gets the orientation in degrees.

setClientId:

- (void) setClientId:

(NSString *)

value

Sets the client identifier.

setDeviceId:

- (void) setDeviceId:

(NSString *)

value

Sets the device identifier.

setHeight:

- (void) setHeight:

(int)

value

Sets the height value.

setOrientation:

- (void) setOrientation:

(int)

value

Sets the orientation in degrees.

setUserId:

- (void) setUserId:

(NSString *)

value

Sets the user identifier.

setViewId:

- (void) setViewId:

(NSString *)

value

Sets the view ID.

setWidth:

- (void) setWidth:

(int)

value

Sets the width value.

setX:

- (void) setX:

(int)

value

Sets the X coordinate.

setY:

- (void) setY:

(int)

value

Sets the Y coordinate.

toJson

- (NSString*) toJson

Serializes this instance to JSON.

toJsonWithLayoutFrame:

+ (NSString*) toJsonWithLayoutFrame:

(FMLiveSwitchLayoutFrame *)

layoutFrame

Serializes a layout frame to JSON.

Parameters

layoutFrame

The layout frame.

userId

- (NSString*) userId

Gets the user identifier.

viewId

- (NSString*) viewId

Gets the view ID.

width

- (int) width

Gets the width value.

x

- (int) x

Gets the X coordinate.

y

- (int) y

Gets the Y coordinate.