Ring_State - cUIObject

Determines whether or not the objects added into the next level of this object are to act as a ring

Type: Property

Access: Read/Write

Data Type: Boolean

Parameters: None

Syntax
 Property Boolean Ring_State

Read Access: Get Ring_State to BooleanVariable
Write Access: Set Ring_State to BooleanVariable/Value


Description

The Ring_state property determines whether or not the objects added into the next level (in the focus tree) of this object are to act as a ring, with the first and last objects in the level wrapping to one another. The objects at the end of the ring will have their prior and next focus set to point at each other. The normal navigation path will remain within the ring of objects.

set ring_state of (a_client(self)) to true


The standard navigation messages switch and switch_back use this arrangement of the focus tree to cause a circular data entry procedure. Container class objects have this property set to true by default, as do other classes whose object creation line includes the ring option (where supported).