Classes
AddedRemovedEvent
AlertElement
AnchorContainerElement
ArrowShape
ButtonElement
CanvasElement
CanvasManager
CheckboxElement
CheckboxSkinElement
CollectionChangedEvent
CollectionSort
ColorPickerButtonElement
ColorPickerElement
ContainerBaseElement
CursorDefinition
DataGridColumnDefinition
DataGridDataRenderer
DataGridElement
DataGridHeaderColumnDividerSkinElement
DataGridHeaderElement
DataGridHeaderItemRenderer
DataGridItemData
DataGridItemRendererBase
DataGridLabelItemRenderer
DataListData
DataListElement
DataRendererBaseElement
DataRendererLabelElement
DatePickerButtonElement
DatePickerElement
DispatcherEvent
DrawMetrics
DropdownArrowButtonSkinElement
DropdownBaseElement
DropdownElement
ElementEvent
ElementGridItemClickEvent
ElementKeyboardEvent
ElementListItemClickEvent
ElementMouseEvent
ElementMouseWheelEvent
EllipseShape
EventDispatcher
FillBase
GridContainerElement
GridContainerRowColumnDefinition
ImageElement
IpInputElement
LabelElement
LinearGradientFill
ListCollection
ListContainerElement
ProgressElement
RadioButtonElement
RadioButtonSkinElement
RoundedRectangleShape
ScrollBarElement
ScrollButtonSkinElement
ShapeBase
SkinnableElement
SolidFill
StyleableBase
StyleChangedEvent
StyleData
StyleDefinition
StyleProxy
TextAreaElement
TextElement
TextFieldElement
TextInputElement
TimeInputElement
ToggleButtonElement
ToggleButtonGroup
Tween
ViewportElement


ContainerBaseElement

Abstract base class for Container elements. Wraps internal child modification functions
such as _addChild() and _removeChild() with public functions such as addElement() and removeElement()
for proper index management when using skins and overlays in conjunction with content children.
Container children are not all considered equal. Content children added via the addElement() and removeElement()
functions maintain their own indexes and are placed in between raw children, such as skins, which render
underneath and overlay children which render above (elements intended to always be on top of content children).
Raw children added via _addChild() or _addChildAt() will be indexed before content children.
Content children added via addElement() or addElementAt() will be indexed after raw children and before overlay children.
Overlay children added via _addOverlayChild() will be index last, after content children.
All 3 lists maintain their own indexes.

Inheritance:     ContainerBaseElement ➞ CanvasElementStyleableBaseStyleDefinitionEventDispatcher ➞ Object

Styles
Show Inherited
Style Defined By
ClipContent     :    boolean [Inheritable] ContainerBaseElement
Determines if out of bounds rendering is allowed. If true the element will clip all rendering
and children's rendering to the elements bounding box. This style is inheritable for container elements.
 


Events
Show Inherited


Public Functions
Show Inherited
Function Defined By
ContainerBaseElement() [Constructor] ContainerBaseElement
Creates new ContainerBaseElement instance.
 
addElement(element) ContainerBaseElement
Adds a content child element to the end of this element's content child list.
  element     :    CanvasElement
CanvasElement to be added as a content child of this element.
  returns     :    CanvasElement
Returns the element just added.
 
addElementAt(element, index) ContainerBaseElement
Inserts a content child element to this element's content child list at the specified index.
  element     :    CanvasElement
CanvasElement to be added as a content child of this element.
  index     :    int
Child index to insert the element.
  returns     :    CanvasElement
Returns the element just added when successful, null if the element could not
be added due to the index being out of range.
 
getElementAt(index) ContainerBaseElement
Gets the content child element at the supplied index.
  index     :    int
Content index of child element to return;
  returns     :    CanvasElement
The CanvasElement at the supplied index, or null if index is out of range.
 
getElementIndex(element) ContainerBaseElement
Returns the index of the supplied content child element.
  element     :    CanvasElement
Content child element to return the index.
  returns     :    int
Returns the child index or -1 if the element is not
a content child of this element.
 
getNumElements() ContainerBaseElement
Gets this elements number of content children.
  returns     :    int
The number of content child elements.
 
removeElement(element) ContainerBaseElement
Removes a content child element from this element's content children list.
  element     :    CanvasElement
Content child to be removed.
  returns     :    CanvasElement
Returns the CanvasElement just removed if successful, null if the
element could not be removed due to it not being a content child of this element.
 
removeElementAt(index) ContainerBaseElement
Removes a content child element at specified index.
  index     :    int
Content index to be removed.
  returns     :    CanvasElement
Returns the CanvasElement just removed if successful, null if the element could
not be removed due it it not being a child of this element, or index out of range.
 
setElementIndex(element, index) ContainerBaseElement
Changes a content child element's index.
  element     :    CanvasElement
Content child element to change index.
  index     :    int
New content index of the content child element.
  returns     :    boolean
Returns true if the child's index is successfully changed, false if the element
is not a content child of this element or the index is out of range.
 


Internal Members
Show Inherited


Internal Functions
Show Inherited
Function Defined By
_addOverlayChild(element) ContainerBaseElement
Adds an overlay child element to the end of this element's overlay child list.
  element     :    CanvasElement
Element to be added as an overlay child of this element.
  returns     :    CanvasElement
Returns the element just added.
 
_addOverlayChildAt(element) ContainerBaseElement
Inserts an overlay child element to this elements overlay child list at the specified index.
  element     :    CanvasElement
Element to be added as an overlay child of this element.
  returns     :    CanvasElement
Returns the element just added when successful, null if the element could not
be added due to the index being out of range.
 
_getNumOverlayChildren() ContainerBaseElement
Gets this elements number of overlay children.
  returns     :    int
The number of overlay child elements.
 
_getOverlayChildAt(index) ContainerBaseElement
Gets the overlay child element at the supplied index.
  index     :    int
Overlay index of child element to return;
  returns     :    CanvasElement
The element at the supplied overlay index, or null if index is out of range.
 
_getOverlayChildIndex(element) ContainerBaseElement
Returns the overlay index of the supplied child element.
  element     :    CanvasElement
Child element to return the overlay index.
  returns     :    int
Returns the child's overlay index or -1 if the element is not
an overlay child of this element.
 
_removeOverlayChild(element) ContainerBaseElement
Removes an overlay child element from this elements overlay child list.
  element     :    CanvasElement
Overlay child to be removed.
  returns     :    CanvasElement
Returns the element just removed if successful, null if the
element could not be removed due to it not being an overlay child of this element.
 
_removeOverlayChildAt(index) ContainerBaseElement
Removes an overlay child element at specified index.
  index     :    int
Overlay index to be removed.
  returns     :    CanvasElement
Returns the element just removed if successful, null if the element could
not be removed due it it not being an overlay child of this element, or index out of range.
 
_setOverlayChildIndex(element, index) ContainerBaseElement
Changes an overlay child element's overlay index.
  element     :    CanvasElement
Overlay child element to change index.
  index     :    int
New overlay index of the child element.
  returns     :    boolean
Returns true if the child's index is successfully changed, false if the element
is not an overlay child of this element or the index is out of range.