AGSLabelStackSeparator Class Reference

Description

A separator character in a label, where a line break may be inserted in long text.

A single separator consists of:

• The separator character that should potentially be replaced by a line break
• If the separator should always be used for line break
• If the separator should remain visible
• If the separator should appear at the end of one row, or the beginning of the next

  Since

  100.11

Inheritance diagram for AGSLabelStackSeparator:

Instance Methods
(instancetype)	- init
(nullable id)	- toJSON:

Class Methods
(nullable id< AGSJSONSerializable >)	+ fromJSON:error:
(instancetype)	+ labelStackSeparator

Properties
AGSLabelStackSeparatorBreakPosition	breakPosition
BOOL	forced
NSString *	separator
NSDictionary< NSString *, id > *	unknownJSON
NSDictionary< NSString *, id > *	unsupportedJSON
BOOL	visible

Method Documentation

fromJSON:error:

+ (nullable id<AGSJSONSerializable>) fromJSON: (id)  JSONObject error: (NSError **)  error

staticrequiredinherited

Initializes and returns an object from its JSON representation.

Parameters

JSONObject	NSDictionary or NSArray containing the JSON.
error	encountered during the operation, if any.

Since

100

init

- (instancetype) init

Creates a label stack separator with default values. The default separator has an empty AGSLabelStackSeparator::separator and will be ignored.

Since

100.11

labelStackSeparator

+ (instancetype) labelStackSeparator

Creates a label stack separator with default values. The default separator has an empty AGSLabelStackSeparator::separator and will be ignored.

Since

100.11

toJSON:

- (nullable id) toJSON: (NSError **)  error

requiredinherited

Returns JSON representation for this object.

Parameters

error

encountered during the operation, if any.

Returns

NSDictionary or NSArray containing the JSON.

Since

100

Reimplemented in AGSPortalItem.

Property Documentation

breakPosition

- (AGSLabelStackSeparatorBreakPosition) breakPosition

readwritenonatomicassign

The position where the separator will be written, if used and remaining visible. Whether the separator code point should appear at the end of one row, or the beginning of the next, if chosen as a line break position. This does not matter if the separator is not to be visible when used.

The default value is AGSLabelStackSeparatorBreakPositionAutomatic, which will give the same behavior as AGSLabelStackSeparatorBreakPositionAfter.

Since

100.11

forced

- (BOOL) forced

readwritenonatomicassign

Whether a line break must be inserted when the AGSLabelStackSeparator::separator is encountered. The default value is NO.

Since

100.11

separator

- (NSString*) separator

readwritenonatomiccopy

An NSString object intended to describe one code point. Each AGSLabelStackSeparator object specifies a code point to be looked for in the text. A code point is often thought of as a single character in the text, but may need several chars in an NSString object to describe it.

For example:

• To use a comma as a separator, the AGSLabelStackSeparator::separator string would be just ","
• To use a Hebrew punctuation Paseq as a separator, the AGSLabelStackSeparator::separator property would need to encode the code point with utf16 value "\u05c0" if your SDK uses utf16 strings (e.g. Java, c#) or with the utf8 string "\x30\x35\x63\x30" if your SDK uses utf8 strings
• To use higher range unicode code points such as Aegean Word Separator Dot which has utf32 hex value 10101, the AGSLabelStackSeparator::separator property would need to encode the code point with utf16 value "\ud800\udd01" if your SDK uses utf16 strings (e.g. Java, c#) or with the utf8 string "\xf0\x90\x84\x81" if your SDK uses utf8 strings The default value is an empty string, meaning that the AGSLabelStackSeparator object will be ignored.

  Since

  100.11

unknownJSON

- (NSDictionary<NSString*,id>*) unknownJSON

readrequirednonatomiccopyinherited

A dictionary of values that was in the source JSON but was unparsed by API.

Returns

NSDictionary containing the unknown JSON.

Since

100

unsupportedJSON

- (NSDictionary<NSString*,id>*) unsupportedJSON

readnonatomiccopyinherited

A dictionary of values that are supported by the REST API, but not exposed through the SDK API.

Returns

NSDictionary containing the unsupported JSON.

Since

100

visible

- (BOOL) visible

readwritenonatomicassign

Whether the separator should still be visible, if chosen as a line break position. For example, a user may wish to keep a hyphenation mark at the end of a row of text, but hide a comma. The default value is NO.

Since

100.11