UIListItemContainer Class Reference

Inheritance diagram for UIListItemContainer:
IUIContainer IUIObject IEZDragDrop

List of all members.

Public Member Functions

void AddChild (GameObject go)
 Reference to the parent UIView.
void RemoveChild (GameObject go)
 Removes an object as a child of the container.
void AddSubject (GameObject go)
 Adds an object as a subject of the container's transitions.
void RemoveSubject (GameObject go)
 Removes an object from being a subject of the container's transitions.
void MakeChild (GameObject go)
 Makes the specified GameObject a child of this container, including making it a child of the container's transform.
SpriteRoot GetElement (string elementName)
 Searches for and returns the first control/element it encounters with the specified name that is a child of this container.
SpriteText GetTextElement (string elementName)
 Searches for and returns the first SpriteText it encounters with the specified name that is a child of this container.
override void OnInput (POINTER_INFO ptr)
 This is where input handling code should go in any derived class.
virtual UIScrollList GetScrollList ()
 Returns the scroll list with which this item is associated.
void Copy (IControl c)
 Copies the the specified control.
void Copy (IControl c, ControlCopyFlags flags)
 Copies the specified parts of the specified control.
void DefaultDragUpdatePosition (POINTER_INFO ptr)
 The default method of updating the drag position.
void SetDragPosUpdater (EZDragDropHelper.UpdateDragPositionDelegate del)
 Sets the delegate to be called in order to update the drag position of the object being dragged.
void CancelDrag ()
 Cancels any pending drag and drop operation.
void CancelFinished ()
 Signals to the object that its cancel drag transition has completed. Only call this yourself if you have overridden the default drag canceling and you are finished animating/whatever the object as a result of having its drag canceled.
void DoDefaultCancelDrag ()
 Performs the default cancel drag animation.
void AddDragDropDelegate (EZDragDropDelegate del)
 Adds a delegate to be called with drag and drop notifications.
void RemoveDragDropDelegate (EZDragDropDelegate del)
 Removes a delegate from the list of those to be called with drag and drop notifications.
void SetDragDropDelegate (EZDragDropDelegate del)
 Sets the delegate to be called with drag and drop notifications. NOTE: This will replace any previously registered delegates.
virtual string GetStateLabel (int index)
 Gets/sets the array of strings that correspond to each control state.
virtual void SetStateLabel (int index, string label)
 Sets the string for the specified state label.

Public Attributes

const string DittoString = "[\"]"
 String whose meaning is to keep the previous state's label.
string text
 Text to be displayed on the control. Do not set this directly in-code. Instead, use the "Text" property or else your changes will not take effect.
SpriteText spriteText
 Reference to optional SpriteText which will display this item's text. It is STRONGLY recommended that this mesh exist on a GameObject that is a child of the list item itself.
float textOffsetZ = -0.1f
 When text is generated by the control at runtime, it will, by default, have its offsetZ setting set to this value. NOTE: Negative values will result in text being in front of the control. Positive values will place the text behind the control.
bool includeTextInAutoCollider
 When true, of a collider is generated for the control, the associated text is taken into account when calculating the extents of the collider.
bool detargetOnDisable = false
 When set to true, the control will instruct any pointers which have it as their target to de-target them. Use this if you are deactivating a control and want no input to go to it. It is strongly recommended NOT to use this feature on any control that appears in a scroll list, or else you may be unable to scroll past the edge of the list's viewable area.
object data
 Can hold a reference to any data that the developer wishes to be associated with the control.
bool isDraggable = false
 Indicates whether the object can be dragged as part of a drag & drop operation.
LayerMask dropMask = -1
 A mask which can be used to make the object only be "droppable" on objects in a certain layer. NOTE: This mask is combined with the camera's mask.
float dragOffset = float.NaN
 The distance an object being dragged and dropped should be offset toward the camera to ensure it hovers above other objects and controls in the scene. A value of NaN indicates the default value will be used from the UIManager.
EZAnimation.EASING_TYPE cancelDragEasing = EZAnimation.EASING_TYPE.Default
 The type of easing to use to animate the object back to its starting position when a drag operation is canceled.
float cancelDragDuration = -1f
 The duration of the easing animation when a drag and drop operation is canceled. A value of -1 indicates to use the default value specified in the UIManager.

Properties

object Data [get, set]
 Accessor for the data member to comply with the IControl interface.
virtual bool controlIsEnabled [get, set]
 Allows you to get/set whether the control is disabled. If it is disabled, it will not receive input.
virtual bool DetargetOnDisable [get, set]
 When set to true, the control will instruct any pointers which have it as their target to de-target them. Use this if you are deactivating a control and want no input to go to it. It is strongly recommended NOT to use this feature on any control that appears in a scroll list, or else you may be unable to scroll past the edge of the list's viewable area.
bool IsDraggable [get, set]
 Indicates whether the object can be dragged as part of a drag & drop operation.
LayerMask DropMask [get, set]
 A mask which can be used to make the object only be "droppable" on objects in a certain layer. NOTE: This mask is combined with the camera's mask.
float DragOffset [get, set]
 The distance an object being dragged and dropped should be offset toward the camera to ensure it hovers above other objects and controls in the scene.
EZAnimation.EASING_TYPE CancelDragEasing [get, set]
 The type of easing to use to animate the object back to its starting position when a drag operation is canceled.
float CancelDragDuration [get, set]
 The duration of the easing animation when a drag and drop operation is canceled.
bool IsDragging [get, set]
 Indicates whether the object is being dragged as part of a drag & drop operation. Setting this value to false while the object is being dragged will cause the drag and drop operation to be canceled.
GameObject DropTarget [get, set]
 The GameObject over which the object being dragged is hovering and will attempt to be dropped if it let go.
bool DropHandled [get, set]
 In the context of a drag & drop operation, this indicates whether the drop action was handled. If this is not set to true in response to a Dropped message sent to OnEZDragDrop(), the drop will be considered to be unhandled and will result in a canceled drop, causing the dragged object to return to its original position.
bool UseDefaultCancelDragAnim [get, set]
 Indicates whether to use the default drag canceling animation.

Detailed Description

UIListItemContainer can be added to a scroll list, but does not provide any control functionality of its own. Instead, it serves as a container for one or more other controls that will appear within the scroll list. In this way, it is somewhat similar to a panel. Like a panel, to cause it to contain other controls, place them as children to the UIListItemContainer's GameObject.

Member Function Documentation

void UIListItemContainer.AddChild ( GameObject  go  ) 

Reference to the parent UIView.

Adds a child to the container.

Parameters:
go GameObject to be added as a child of the container.

Implements IUIContainer.

void ControlBase.AddDragDropDelegate ( EZDragDropDelegate  del  )  [inherited]

Adds a delegate to be called with drag and drop notifications.

Parameters:
del The delegate to add.
void UIListItemContainer.AddSubject ( GameObject  go  ) 

Adds an object as a subject of the container's transitions.

Parameters:
go GameObject that is subject to the container's transitions.

Implements IUIContainer.

void ControlBase.CancelDrag (  )  [inherited]

Cancels any pending drag and drop operation.

void ControlBase.CancelFinished (  )  [inherited]

Signals to the object that its cancel drag transition has completed. Only call this yourself if you have overridden the default drag canceling and you are finished animating/whatever the object as a result of having its drag canceled.

void IControl.Copy ( IControl  c,
ControlCopyFlags  flags 
) [inherited]

Copies the specified parts of the specified control.

Parameters:
c The control to be copied.
flags Flags specifying which attributes of the control are to be copied.
void IControl.Copy ( IControl  c  )  [inherited]

Copies the the specified control.

Parameters:
c The control to be copied.
void ControlBase.DefaultDragUpdatePosition ( POINTER_INFO  ptr  )  [inherited]

The default method of updating the drag position.

Parameters:
ptr The pointer info struct for the pointer dragging the object.
void ControlBase.DoDefaultCancelDrag (  )  [inherited]

Performs the default cancel drag animation.

SpriteRoot UIListItemContainer.GetElement ( string  elementName  ) 

Searches for and returns the first control/element it encounters with the specified name that is a child of this container.

Parameters:
elementName Name of the control/element to be found.
Returns:
Returns the first control/element found with the specified name. Null is returned if no matching control is found.
virtual UIScrollList UIListItemContainer.GetScrollList (  )  [virtual]

Returns the scroll list with which this item is associated.

Returns:
The scroll list.
virtual string ControlBase.GetStateLabel ( int  index  )  [virtual, inherited]

Gets/sets the array of strings that correspond to each control state.

SpriteText UIListItemContainer.GetTextElement ( string  elementName  ) 

Searches for and returns the first SpriteText it encounters with the specified name that is a child of this container.

Parameters:
elementName Name of the text element to be found.
Returns:
Returns the first text element found with the specified name. Null is returned if no matching control is found.
void UIListItemContainer.MakeChild ( GameObject  go  ) 

Makes the specified GameObject a child of this container, including making it a child of the container's transform.

Parameters:
go GameObject to make a child of the panel.
override void UIListItemContainer.OnInput ( POINTER_INFO  ptr  ) 

This is where input handling code should go in any derived class.

Parameters:
ptr POINTER_INFO struct that contains information on the pointer that caused the event, as well as the event that occurred.

Implements IUIObject.

void UIListItemContainer.RemoveChild ( GameObject  go  ) 

Removes an object as a child of the container.

Parameters:
go Object to be removed.

Implements IUIContainer.

void ControlBase.RemoveDragDropDelegate ( EZDragDropDelegate  del  )  [inherited]

Removes a delegate from the list of those to be called with drag and drop notifications.

Parameters:
del The delegate to add.
void UIListItemContainer.RemoveSubject ( GameObject  go  ) 

Removes an object from being a subject of the container's transitions.

Parameters:
go GameObject that should no longer be subject to the container's transitions.

Implements IUIContainer.

void ControlBase.SetDragDropDelegate ( EZDragDropDelegate  del  )  [inherited]

Sets the delegate to be called with drag and drop notifications. NOTE: This will replace any previously registered delegates.

Parameters:
del The delegate to add.
void ControlBase.SetDragPosUpdater ( EZDragDropHelper.UpdateDragPositionDelegate  del  )  [inherited]

Sets the delegate to be called in order to update the drag position of the object being dragged.

Parameters:
del The delegate that will update the object's position.
virtual void ControlBase.SetStateLabel ( int  index,
string  label 
) [virtual, inherited]

Sets the string for the specified state label.

Parameters:
index index of the state to set.
label The string to set as the state's label.

Member Data Documentation

float ControlBase.cancelDragDuration = -1f [inherited]

The duration of the easing animation when a drag and drop operation is canceled. A value of -1 indicates to use the default value specified in the UIManager.

EZAnimation.EASING_TYPE ControlBase.cancelDragEasing = EZAnimation.EASING_TYPE.Default [inherited]

The type of easing to use to animate the object back to its starting position when a drag operation is canceled.

object ControlBase.data [inherited]

Can hold a reference to any data that the developer wishes to be associated with the control.

bool ControlBase.detargetOnDisable = false [inherited]

When set to true, the control will instruct any pointers which have it as their target to de-target them. Use this if you are deactivating a control and want no input to go to it. It is strongly recommended NOT to use this feature on any control that appears in a scroll list, or else you may be unable to scroll past the edge of the list's viewable area.

const string ControlBase.DittoString = "[\"]" [inherited]

String whose meaning is to keep the previous state's label.

float ControlBase.dragOffset = float.NaN [inherited]

The distance an object being dragged and dropped should be offset toward the camera to ensure it hovers above other objects and controls in the scene. A value of NaN indicates the default value will be used from the UIManager.

LayerMask ControlBase.dropMask = -1 [inherited]

A mask which can be used to make the object only be "droppable" on objects in a certain layer. NOTE: This mask is combined with the camera's mask.

bool ControlBase.includeTextInAutoCollider [inherited]

When true, of a collider is generated for the control, the associated text is taken into account when calculating the extents of the collider.

bool ControlBase.isDraggable = false [inherited]

Indicates whether the object can be dragged as part of a drag & drop operation.

SpriteText ControlBase.spriteText [inherited]

Reference to optional SpriteText which will display this item's text. It is STRONGLY recommended that this mesh exist on a GameObject that is a child of the list item itself.

string ControlBase.text [inherited]

Text to be displayed on the control. Do not set this directly in-code. Instead, use the "Text" property or else your changes will not take effect.

float ControlBase.textOffsetZ = -0.1f [inherited]

When text is generated by the control at runtime, it will, by default, have its offsetZ setting set to this value. NOTE: Negative values will result in text being in front of the control. Positive values will place the text behind the control.

Property Documentation

float ControlBase.CancelDragDuration [get, set, inherited]

The duration of the easing animation when a drag and drop operation is canceled.

EZAnimation.EASING_TYPE ControlBase.CancelDragEasing [get, set, inherited]

The type of easing to use to animate the object back to its starting position when a drag operation is canceled.

virtual bool ControlBase.controlIsEnabled [get, set, inherited]

Allows you to get/set whether the control is disabled. If it is disabled, it will not receive input.

object ControlBase.Data [get, set, inherited]

Accessor for the data member to comply with the IControl interface.

virtual bool ControlBase.DetargetOnDisable [get, set, inherited]

When set to true, the control will instruct any pointers which have it as their target to de-target them. Use this if you are deactivating a control and want no input to go to it. It is strongly recommended NOT to use this feature on any control that appears in a scroll list, or else you may be unable to scroll past the edge of the list's viewable area.

float ControlBase.DragOffset [get, set, inherited]

The distance an object being dragged and dropped should be offset toward the camera to ensure it hovers above other objects and controls in the scene.

bool ControlBase.DropHandled [get, set, inherited]

In the context of a drag & drop operation, this indicates whether the drop action was handled. If this is not set to true in response to a Dropped message sent to OnEZDragDrop(), the drop will be considered to be unhandled and will result in a canceled drop, causing the dragged object to return to its original position.

LayerMask ControlBase.DropMask [get, set, inherited]

A mask which can be used to make the object only be "droppable" on objects in a certain layer. NOTE: This mask is combined with the camera's mask.

GameObject ControlBase.DropTarget [get, set, inherited]

The GameObject over which the object being dragged is hovering and will attempt to be dropped if it let go.

bool ControlBase.IsDraggable [get, set, inherited]

Indicates whether the object can be dragged as part of a drag & drop operation.

bool ControlBase.IsDragging [get, set, inherited]

Indicates whether the object is being dragged as part of a drag & drop operation. Setting this value to false while the object is being dragged will cause the drag and drop operation to be canceled.

bool ControlBase.UseDefaultCancelDragAnim [get, set, inherited]

Indicates whether to use the default drag canceling animation.

The documentation for this class was generated from the following file:
Generated on Thu Sep 8 16:31:19 2011 for EZ GUI by  doxygen 1.6.1