class HierarchicalItemRenderer

An optional display object positioned on the right side of the item renderer.

The following example passes a button to use as the accessory view:

itemRenderer.accessoryView = new Button("Info");

The display object to use as the background skin when the alternate skin is enabled.

The following example passes a bitmap to use as an alternate background skin:

itemRenderer.alternateBackgroundSkin = new Bitmap(bitmapData);

See also:

• BasicButton.backgroundSkin

See also:

• feathers.core.IFocusContainer.childFocusEnabled

See also:

• feathers.controls.dataRenderers.IDataRenderer.data

The font styles used to render the item renderer's secondary text when the item renderer is disabled.

In the following example, the item renderer's secondary disabled text formatting is customized:

itemRenderer.enabled = false;
itemRenderer.disabledSecondaryTextFormat = new TextFormat("Helvetica", 20, 0xee0000);

The next example sets a disabled secondary text format, but also provides a text format for the ToggleButtonState.DISABLED(true) state that will be used instead of the disabled secondary text format:

itemRenderer.disabledSecondaryTextFormat = new TextFormat("Helvetica", 20, 0xee0000);
itemRenderer.setSecondaryTextFormatForState(ToggleButtonState.DISABLED(true), new TextFormat("Helvetica", 20, 0xff0000));

Note: If the current state is ToggleButtonState.DISABLED(true), and both the disabledSecondaryTextFormat and selectedSecondaryTextFormat are set, the disabledSecondaryTextFormat takes precedence over the selectedSecondaryTextFormat.

See also:

• ItemRenderer.secondaryTextFormat

See also:

• feathers.layout.ILayoutIndexObject.layoutIndex

See also:

• feathers.core.IPointerDelegate.pointerTarget

Secondary text displayed by the button that is parsed as a simple form of HTML.

The following example sets the button's secondary HTML text:

button.secondaryHtmlText = "<b>Hello</b> <i>World</i>";

See also:

• ItemRenderer.secondaryText

• openfl.text.TextField.htmlText

The optional secondary text displayed by the item renderer.

The following example sets the item renderer's secondary text:

itemRenderer.secondaryText = "Click Me";

See also:

• ItemRenderer.secondaryTextFormat

The font styles used to render the item renderer's secondary text.

In the following example, the item renderer's secondary text formatting is customized:

itemRenderer.secondaryTextFormat = new TextFormat("Helvetica", 20, 0xcc0000);

See also:

• ToggleButton.secondaryText

The font styles used to render the item renderer's secondary text when the item renderer is selected.

In the following example, the item renderer's selected secondary text formatting is customized:

itemRenderer.selected = true;
itemRenderer.selectedSecondaryTextFormat = new TextFormat("Helvetica", 20, 0xff0000);

The next example sets a selected secondary text format, but also provides a text format for the ToggleButtonState.DOWN(true) state that will be used instead of the selected secondary text format:

itemRenderer.selectedSecondaryTextFormat = new TextFormat("Helvetica", 20, 0xff0000);
itemRenderer.setSecondaryTextFormatForState(ToggleButtonState.DOWN(true), new TextFormat("Helvetica", 20, 0xcc0000));

Note: If the current state is ToggleButtonState.DISABLED(true), and both the disabledSecondaryTextFormat and selectedSecondaryTextFormat are set, the disabledSecondaryTextFormat takes precedence over the selectedSecondaryTextFormat.

See also:

• ItemRenderer.secondaryTextFormat

• BasicToggleButton.selected

Indicates if hover and down states are enabled or not. Can be set to false for items that are intended for display only, and should not appear interactive for mouse and keyboard trigger events or selection.

The ToggleButtonState.UP state will be used instead of ToggleButtonState.HOVER and ToggleButtonState.DOWN. However, the item may still render differently when selected versus when it is not selected.

Shows or hides the item renderer's secondary text. If the secondary text is hidden, it will not affect the layout of other children, such as the primary text or the icon.

See also:

• feathers.controls.ITextControl.baseline

The icon to display when the button is disabled, and no higher priority icon was passed to setIconForState() for the button's current state.

In the following example, the button's disabled icon is changed:

button.enabled = false;
button.disabledIcon = new Bitmap(bitmapData);

The next example sets a disabled icon, but also provides an icon for the ToggleButtonState.DISABLED(true) state that will be used instead of the disabled icon:

button.disabledIcon = new Bitmap(bitmapData);
button.setIconForState(ToggleButtonState.DISABLED(true), new Bitmap(bitmapData2));

Note: If the current state is ToggleButtonState.DISABLED(true), and both the disabledIcon and selectedIcon are set, the disabledIcon takes precedence over the selectedIcon.

See also:

• ToggleButton.icon

The font styles used to render the button's text when the button is disabled.

In the following example, the button's disabled text formatting is customized:

button.enabled = false;
button.disabledTextFormat = new TextFormat("Helvetica", 20, 0xee0000);

The next example sets a disabled text format, but also provides a text format for the ToggleButtonState.DISABLED(true) state that will be used instead of the disabled text format:

button.disabledTextFormat = new TextFormat("Helvetica", 20, 0xee0000);
button.setTextFormatForState(ToggleButtonState.DISABLED(true), new TextFormat("Helvetica", 20, 0xff0000));

Note: If the current state is ToggleButtonState.DISABLED(true), and both the disabledTextFormat and selectedTextFormat are set, the disabledTextFormat takes precedence over the selectedTextFormat.

See also:

• ToggleButton.textFormat

Determines if an embedded font is used or not.

In the following example, the button uses embedded fonts:

button.embedFonts = true;

See also:

• ToggleButton.textFormat

The space, measured in pixels, between the button's icon and its text. Applies to either horizontal or vertical spacing, depending on the value of iconPosition.

If the gap is set to Math.POSITIVE_INFINITY, the icon and the text will be positioned as far apart as possible. In other words, they will be positioned at the edges of the button (adjusted for padding).

The following example creates a gap of 20 pixels between the icon and the text:

button.text = "Click Me";
button.icon = new Bitmap(bitmapData);
button.gap = 20.0;

See also:

• ToggleButton.minGap

How the content is positioned horizontally (along the x-axis) within the button.

The following example aligns the button's content to the left:

button.verticalAlign = LEFT;

Note: The HorizontalAlign.JUSTIFY constant is not supported by this component.

See also:

• feathers.layout.HorizontalAlign.LEFT

• feathers.layout.HorizontalAlign.CENTER

• feathers.layout.HorizontalAlign.RIGHT

Text displayed by the button that is parsed as a simple form of HTML.

The following example sets the button's HTML text:

button.htmlText = "<b>Hello</b> <i>World</i>";

See also:

• ToggleButton.text

• openfl.text.TextField.htmlText

The display object to use as the button's icon.

To render a different icon depending on the button's current state, pass additional icons to setIconForState().

The following example gives the button an icon:

button.icon = new Bitmap(bitmapData);

To change the position of the icon relative to the button's text, see iconPosition and gap.

button.icon = new Bitmap(bitmapData);
button.iconPosition = RIGHT;
button.gap = 20.0;

See also:

• ToggleButton.getIconForState()

• ToggleButton.setIconForState()

• ToggleButton.iconPosition

• ToggleButton.gap

Offsets the x position of the icon by a certain number of pixels. This does not affect the measurement of the button. The button's width will not get smaller or larger when the icon is offset from its default x position.

The following example offsets the x position of the button's icon by 20 pixels:

button.iconOffsetX = 20.0;

See also:

• ToggleButton.iconOffsetY

Offsets the y position of the icon by a certain number of pixels. This does not affect the measurement of the button. The button's height will not get smaller or larger when the icon is offset from its default y position.

The following example offsets the y position of the button's icon by 20 pixels:

button.iconOffsetY = 20.0;

See also:

• ToggleButton.iconOffsetX

The location of the button's icon, relative to its text.

The following example positions the icon to the right of the text:

button.text = "Click Me";
button.icon = new Bitmap(texture);
button.iconPosition = RIGHT;

See also:

• ToggleButton.icon

If the value of the gap property is Math.POSITIVE_INFINITY, meaning that the gap will fill as much space as possible and position the icon and text on the edges of the button, the final calculated value of the gap will not be smaller than the value of the minGap property.

The following example ensures that the gap is never smaller than 20 pixels:

button.gap = Math.POSITIVE_INFINITY;
button.minGap = 20.0;

See also:

• ToggleButton.gap

The minimum space, in pixels, between the button's bottom edge and the button's content.

In the following example, the button's bottom padding is set to 20 pixels:

button.paddingBottom = 20.0;

The minimum space, in pixels, between the button's left edge and the button's content.

In the following example, the button's left padding is set to 20 pixels:

button.paddingLeft = 20.0;

The minimum space, in pixels, between the button's right edge and the button's content.

In the following example, the button's right padding is set to 20 pixels:

button.paddingRight = 20.0;

The minimum space, in pixels, between the button's top edge and the button's content.

In the following example, the button's top padding is set to 20 pixels:

button.paddingTop = 20.0;

The icon to display when the button is selected, and no higher priority icon was passed to setIconForState() for the button's current state.

In the following example, the button's selected icon is changed:

button.selected = true;
button.selectedIcon = new Bitmap(bitmapData);

The next example sets a selected icon, but also provides an icon for the ToggleButtonState.DOWN(true) state that will be used instead of the selected icon:

button.selectedIcon = new Bitmap(bitmapData);
button.setIconForState(ToggleButtonState.DOWN(true), new Bitmap(bitmapData2));

Note: If the current state is ToggleButtonState.DISABLED(true), and both the disabledIcon and selectedIcon are set, the disabledIcon takes precedence over the selectedIcon.

See also:

• ToggleButton.icon

• BasicToggleButton.selected

The font styles used to render the button's text when the button is selected.

In the following example, the button's selected text formatting is customized:

button.selected = true;
button.selectedTextFormat = new TextFormat("Helvetica", 20, 0xff0000);

The next example sets a selected text format, but also provides a text format for the ToggleButtonState.DOWN(true) state that will be used instead of the selected text format:

button.selectedTextFormat = new TextFormat("Helvetica", 20, 0xff0000);
button.setTextFormatForState(ToggleButtonState.DOWN(true), new TextFormat("Helvetica", 20, 0xcc0000));

Note: If the current state is ToggleButtonState.DISABLED(true), and both the disabledTextFormat and selectedTextFormat are set, the disabledTextFormat takes precedence over the selectedTextFormat.

See also:

• ToggleButton.textFormat

• BasicToggleButton.selected

Shows or hides the button text. If the text is hidden, it will not affect the layout of other children, such as the icon.

The text displayed by the button.

The following example sets the button's text:

button.text = "Click Me";

Note: If the htmlText property is not null, the text property will be ignored.

See also:

• ToggleButton.htmlText

• ToggleButton.textFormat

The font styles used to render the button's text.

In the following example, the button's text formatting is customized:

button.textFormat = new TextFormat("Helvetica", 20, 0xcc0000);

See also:

• ToggleButton.text

• ToggleButton.getTextFormatForState()

• ToggleButton.setTextFormatForState()

• ToggleButton.embedFonts

Offsets the x position of the text by a certain number of pixels. This does not affect the measurement of the button. The button's width will not get smaller or larger when the text is offset from its default x position. Nor does it change the size of the text, so the text may appear outside of the button's bounds if the offset is large enough.

The following example offsets the x position of the button's text by 20 pixels:

button.textOffsetX = 20.0;

See also:

• ToggleButton.textOffsetY

Offsets the y position of the text by a certain number of pixels. This does not affect the measurement of the button. The button's height will not get smaller or larger when the text is offset from its default y position. Nor does it change the size of the text, so the text may appear outside of the button's bounds if the offset is large enough.

The following example offsets the y position of the button's text by 20 pixels:

button.textOffsetY = 20.0;

See also:

• ToggleButton.textOffsetX

How the content is positioned vertically (along the y-axis) within the button.

The following example aligns the button's content to the top:

button.verticalAlign = TOP;

Note: The VerticalAlign.JUSTIFY constant is not supported by this component.

See also:

• feathers.layout.VerticalAlign.TOP

• feathers.layout.VerticalAlign.MIDDLE

• feathers.layout.VerticalAlign.BOTTOM

Determines if the text is displayed on a single line, or if it wraps.

In the following example, the button's text wraps at 150 pixels:

button.width = 150.0;
button.wordWrap = true;

The default background skin for the toggle button, which is used when no other skin is defined for the current state with setSkinForState().

The following example passes a bitmap for the button to use as a background skin:

button.backgroundSkin = new Bitmap(bitmapData);

See also:

• BasicToggleButton.getSkinForState()

• BasicToggleButton.setSkinForState()

The current state of the toggle button.

When the value of the currentState property changes, the button will dispatch an event of type FeathersEvent.STATE_CHANGE.

See also:

• feathers.controls.ToggleButtonState

• feathers.events.FeathersEvent.STATE_CHANGE

Determines if a pressed button should remain in the down state if the pointer moves outside of the button's bounds. Useful for controls like HSlider, VSlider, or ToggleSwitch to keep a thumb in the down state while it is being dragged around by the pointer.

The following example ensures that the button's down state remains active on roll out.

button.keepDownStateOnRollOut = true;

Indicates if the button is selected or not. The button may be selected programmatically, even if toggleable is false, but generally, toggleable should be set to true to allow the user to select and deselect it by triggering the button with a click or tap. If focus management is enabled, and the button has focus, a button may also be triggered with the spacebar.

When the value of the selected property changes, the button will dispatch an event of type Event.CHANGE.

The following example selects the button:

button.selected = true;

The following example listens for changes to the selected property:

button.addEventListener(Event.CHANGE, (event:Event) -> {
	trace("selected changed: " + button.selected)
});

Warning: Do not listen for TriggerEvent.TRIGGER to be notified when the selected property changes. You must listen for Event.CHANGE, which is dispatched after TriggerEvent.TRIGGER.

See also:

• BasicToggleButton.toggleable

The default background skin for the toggle button when the selected property is true. Takes precendence over backgroundSkin, but will defer to another skin that is defined for the current state with setSkinForState().

The following example gives the toggle button a default selected skin:

button.selectedBackgroundSkin = new Bitmap(bitmapData);

See also:

• BasicToggleButton.backgroundSkin

• BasicToggleButton.getSkinForState()

• BasicToggleButton.setSkinForState()

• BasicToggleButton.selected

Determines if the button may be selected or deselected as a result of user interaction. If true, the value of the selected property will be toggled when the button is triggered.

The following example disables the ability to toggle on click or tap:

button.toggleable = false;

See also:

• BasicToggleButton.selected

• feathers.events.TriggerEvent.TRIGGER

Indicates if the focusRectSkin should always be displayed when the component is focused, or only after keyboard focus changes.

Determines if the component has been initialized and validated for the first time.

In the following example, we check if the component is created or not, and we listen for an event if it isn't:

if(!control.created)
{
	control.addEventListener(FeathersEventType.CREATION_COMPLETE, creationCompleteHandler);
}

See also:

• FeathersEvent.CREATION_COMPLETE

• FeathersControl.update()

When disabledAlpha is not null, sets the alpha property to this value when the the enabled property is set to false.

See also:

• feathers.core.IUIControl.enabled

See also:

• feathers.layout.IFocusObject.focusEnabled

See also:

• feathers.layout.IFocusObject.focusManager

See also:

• feathers.layout.IFocusObject.focusOwner

Optional padding outside the bottom edge of this UI component when the focusRectSkin is visible.

Optional padding outside the left edge of this UI component when the focusRectSkin is visible.

Optional padding outside the right edge of this UI component when the focusRectSkin is visible.

Optional padding outside the top edge of this UI component when the focusRectSkin is visible.

An optional skin to display when an IFocusObject component receives focus.

See also:

• feathers.layout.ILayoutObject.includeInLayout

Determines if the component has been initialized yet. The initialize() function is called one time only, when the Feathers UI control is added to the display list for the first time.

In the following example, we check if the component is initialized or not, and we listen for an event if it isn't initialized:

if(!control.initialized)
{
	control.addEventListener(FeathersEvent.INITIALIZE, initializeHandler);
}

See also:

• FeathersEvent.INITIALIZE

• FeathersControl.initialize()

See also:

• feathers.layout.ILayoutObject.layoutData

The class used as the context for styling the component. If a subclass of a component should have different styles than its superclass, it should override the get_styleContext getter. However, if a subclass should continue using the same styles as its superclass, it happens automatically.

Typically used by the theme to provide styles to each component, but a custom style provider may be provided that will take precedence over the theme's style provider.

When a component initializes, its style provider sets properties that affect the component's visual appearance. If the style provider dispatches StyleProviderEvent.STYLES_CHANGE after the component has initialized, the original properties set by the style provider will be reset to their default values and before applying the new property values.

Setting the style provider or replacing an existing style provider before a component initializes will queue up the style changes until after initialization. Once a component initializes, the style provider may be changed, but the changes will be applied immediately. Similarly to when a style provider dispatcches StyleProviderEvent.STYLES_CHANGE, any properties that were set by the previous style provider will be reset to their default values before applying the new style provider.

If the themeEnabled property is false, the current theme's style provider will be ignored. However, if a custom style provider was provided from outside of the theme, it will still be used.

See also:

• FeathersControl.themeEnabled

• FeathersControl.variant

• Introduction to Feathers UI themes

See also:

• feathers.style.IStyleObject.themeEnabled

See also:

• feathers.core.IUIControl.toolTip

May be used to provide multiple different variations of the same UI component, each with a different appearance.

See also:

• feathers.core.IMeasureObject.explicitHeight

See also:

• feathers.core.IMeasureObject.explicitMaxHeight

See also:

• feathers.core.IMeasureObject.explicitMaxWidth

See also:

• feathers.core.IMeasureObject.explicitMinHeight

See also:

• feathers.core.IMeasureObject.explicitMinWidth

See also:

• feathers.core.IMeasureObject.explicitWidth

See also:

• feathers.core.IMeasureObject.maxHeight

See also:

• feathers.core.IMeasureObject.maxWidth

See also:

• feathers.core.IMeasureObject.minHeight

See also:

• feathers.core.IMeasureObject.minWidth

See also:

• feathers.core.IValidating.depth

Indicates if the display object is currently validating.

Gets the secondary text format to be used by the item renderer when its currentState property matches the specified state value.

If a secondary text format is not defined for a specific state, returns null.

See also:

• ToggleButton.setSecondaryTextFormatForState()

• ToggleButton.secondaryTextFormat

• ToggleButton.currentState

• feathers.controls.ToggleButtonState

Set the secondary text format to be used by the item renderer when its currentState property matches the specified state value.

If a secondary text format is not defined for a specific state, the value of the secondaryTextFormat property will be used instead.

See also:

• ItemRenderer.getSecondaryTextFormatForState()

• ItemRenderer.secondaryTextFormat

• ItemRenderer.currentState

• feathers.controls.ToggleButtonState

Gets the icon to be used by the button when its currentState property matches the specified state value.

If an icon is not defined for a specific state, returns null.

See also:

• ToggleButton.setIconForState()

• ToggleButton.icon

• ToggleButton.currentState

• feathers.controls.ToggleButtonState

Gets the text format to be used by the button when its currentState property matches the specified state value.

If a text format is not defined for a specific state, returns null.

See also:

• ToggleButton.setTextFormatForState()

• ToggleButton.textFormat

• ToggleButton.currentState

• feathers.controls.ToggleButtonState

Set the icon to be used by the button when its currentState property matches the specified state value.

If an icon is not defined for a specific state, the value of the textFormat property will be used instead.

See also:

• ToggleButton.getIconForState()

• ToggleButton.icon

• ToggleButton.currentState

• feathers.controls.ToggleButtonState

Sets all four padding properties to the same value.

See also:

• ToggleButton.paddingTop

• ToggleButton.paddingRight

• ToggleButton.paddingBottom

• ToggleButton.paddingLeft

Set the text format to be used by the button when its currentState property matches the specified state value.

If a text format is not defined for a specific state, the value of the textFormat property will be used instead.

See also:

• ToggleButton.getTextFormatForState()

• ToggleButton.textFormat

• ToggleButton.currentState

• feathers.controls.ToggleButtonState

Gets the skin to be used by the toggle button when its currentState property matches the specified state value.

If a skin is not defined for a specific state, returns null.

See also:

• BasicToggleButton.setSkinForState()

• BasicToggleButton.backgroundSkin

• BasicToggleButton.currentState

• feathers.controls.ToggleButtonState

Set the skin to be used by the toggle button when its currentState property matches the specified state value.

If a skin is not defined for a specific state, the value of the backgroundSkin property will be used instead.

See also:

• BasicToggleButton.getSkinForState()

• BasicToggleButton.backgroundSkin

• BasicToggleButton.currentState

• feathers.controls.ToggleButtonState

Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process. Do things like create children and set up event listeners. After this function is called, `FeathersEvent.INITIALIZE is dispatched.

The following example overrides initialization:

override private function initialize():Void {
	super.initialize();

}

See also:

• feathers.events.FeathersEvent.INITIALIZE

See also:

• feathers.core.IUIControl.initializeNow

Sets both the x and y positions of the control in a single function call.

See also:

• DisplayObject.x

• DisplayObject.y

Sets all four padding properties to the same value.

See also:

• FeathersControl.focusPaddingTop

• FeathersControl.focusPaddingRight

• FeathersControl.focusPaddingBottom

• FeathersControl.focusPaddingLeft

Sets both the width and height dimensions of the control in a single function call.

See also:

• DisplayObject.width

• DisplayObject.height

Determines if a style may be changed, and restricts the style from being changed in the future, if necessary.

See also:

• feathers.core.IFocusObject.showFocus()

See also:

• feathers.core.IMeasureObject.resetHeight

See also:

• feathers.core.IMeasureObject.resetMaxHeight

See also:

• feathers.core.IMeasureObject.resetMaxWidth

See also:

• feathers.core.IMeasureObject.resetMinHeight

See also:

• feathers.core.IMeasureObject.resetMinWidth

See also:

• feathers.core.IMeasureObject.resetWidth

Saves the calculated dimensions for the component, replacing any values that haven't been set explicitly. Returns true if the reported values have changed and Event.RESIZE was dispatched.

Indicates whether the control is pending validation or not. By default, returns true if any invalidation flag has been set. If you pass in a specific flag, returns true only if that flag has been set (others may be set too, but it checks the specific flag only. If all flags have been marked as invalid, always returns true.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true

Calls a function that temporarily limits setInvalid() calls to setting invalidation flags only, and the control will not be added to the validation queue. In other words, setInvalid() calls will work similarly to setInvalidationFlag() instead.

Typically, this method should be called only during validation. If called outside of update(), the component's validation may be delayed until a future call to setInvalid().

Calls a function that temporarily disables invalidation. In other words, calls to setInvalid() will be ignored until the function returns.

Call this function to tell the UI control that a redraw is pending. The redraw will happen immediately before OpenFL renders the UI control to the screen. The validation system exists to ensure that multiple properties can be set together without redrawing multiple times in between each property change.

If you cannot wait until later for the validation to happen, you can call validate() to redraw immediately. As an example, you might want to validate immediately if you need to access the correct width or height values of the UI control, since these values are calculated during validation.

The following example invalidates a component:

component.setInvalid();
trace(component.isInvalid()); // true

Sets an invalidation flag. This will not add the component to the validation queue. It only sets the flag. A subclass might use this function during draw() to manipulate the flags that its superclass sees.

See also:

• ValidatingSprite.setInvalid()

Override to customize layout and to adjust properties of children. Called when the component validates, if any flags have been marked to indicate that validation is pending.

The following example overrides updating after invalidation:

override private function update():Void {
	super.update();

}