org.fujion.component

Class Tab

java.lang.Object

org.fujion.component.BaseComponent

org.fujion.component.BaseUIComponent

org.fujion.component.BaseLabeledComponent<P>

org.fujion.component.BaseLabeledImageComponent<BaseLabeledComponent.LabelPositionNone>

org.fujion.component.Tab

All Implemented Interfaces:

IDisable, IElementIdentifier, ILabeled, IClientTransform, IAttributeMap<String,Object>

@Component(tag="tab",
           widgetModule="fujion-tabview",
           widgetClass="Tab",
           content=AS_CHILD,
           parentTag="tabview",
           childTag=@Component.ChildTag(value="*"),
           description="A single tab in a tab view.")
public class Tab
extends BaseLabeledImageComponent<BaseLabeledComponent.LabelPositionNone>

A single tab in a tab view.

Nested Class Summary

Nested classes/interfaces inherited from class org.fujion.component.BaseLabeledComponent

BaseLabeledComponent.ILabelPosition, BaseLabeledComponent.LabelPositionAll, BaseLabeledComponent.LabelPositionHorz, BaseLabeledComponent.LabelPositionNone

Nested classes/interfaces inherited from class org.fujion.component.BaseComponent

BaseComponent.SubComponent

Field Summary

Fields inherited from interface org.fujion.ancillary.IElementIdentifier

log

Constructor Summary

Constructors

Constructor and Description
Tab()
Tab(String label)

Method Summary

Modifier and Type	Method and Description
protected void	_setSelected(boolean selected, boolean notifyParent) Sets the tabs selected status.
void	bringToFront() Override to cause a UI component to be brought to the forefront of the UI.
boolean	canClose() Invokes the canClose logic and returns the result.
boolean	close() Request the tab to be closed.
BooleanSupplier	getOnCanClose() Returns the functional interface that determines whether tab closure is permitted.
Tabview	getTabview()
boolean	isClosable() Returns true if the tab is closable.
boolean	isSelected() Returns the selection state of the tab.
void	setClosable(boolean closable) Set to true to make the tab closable.
void	setOnCanClose(boolean canClose) Sets whether tab closure is permitted using a simple Boolean value.
void	setOnCanClose(BooleanSupplier onCanClose) Sets the functional interface that will determine if tab closure is permitted.
void	setSelected(boolean selected) Sets the selection state of the tab.

Methods inherited from class org.fujion.component.BaseLabeledImageComponent

getImage, setImage

Methods inherited from class org.fujion.component.BaseLabeledComponent

getLabel, getPosition, setLabel, setPosition

Methods inherited from class org.fujion.component.BaseUIComponent

_syncClasses, _syncStyles, addClass, addMask, addMask, addMask, addStyle, addStyles, afterRemoveChild, focus, getBalloon, getClasses, getContext, getCss, getDragid, getDropid, getFirstVisibleChild, getFirstVisibleChild, getFlex, getHeight, getHint, getKeycapture, getPopup, getStyle, getStyles, getTabindex, getWidth, hide, isDisabled, isVisible, onDestroyTracked, print, print, removeClass, removeMask, removeStyle, reportSize, scrollIntoView, setBalloon, setClasses, setContext, setCss, setDisabled, setDragid, setDropid, setFlex, setFocus, setHeight, setHint, setKeycapture, setPopup, setStyles, setTabindex, setVisible, setWidth, show, toggleClass

Methods inherited from class org.fujion.component.BaseComponent

_attach, _initProps, addChild, addChild, addChild, addChildren, addComposite, addEventForward, addEventForward, addEventForward, addEventForward, addEventListener, addEventListener, addEventListener, addEventListener, afterAddChild, afterSetParent, areEqual, beforeAddChild, beforeRemoveChild, beforeSetParent, bind, defaultify, destroy, destroyChildren, detach, detachChildren, finalize, findAllNamed, findAttribute, findByName, findByName, findChildByData, findChildByLabel, fireEvent, fireEvent, fireEventToClient, fireEventToClient, getAncestor, getAncestor, getAttribute, getAttribute, getAttributes, getChild, getChildAt, getChildCount, getChildCount, getChildren, getChildren, getContent, getController, getControllers, getData, getData, getDefinition, getFirstChild, getId, getIndex, getLastChild, getLastController, getName, getNamespace, getNextSibling, getPage, getParent, getPreviousSibling, getRoot, hasChildren, hasEventListener, hasEventListener, invoke, invoke, invoke, invoke, invoke, invokeIfAttached, isAncestor, isContainer, isContentSynced, isDead, isNamespace, isRendered, loadModule, loadModule, notifyAncestors, notifyDescendants, nullify, onAttach, onDestroy, propertyChange, removeChild, removeEventForward, removeEventForward, removeEventForward, removeEventForward, removeEventListener, removeEventListener, removeEventListener, removeEventListener, setContent, setContentSynced, setData, setIndex, setName, setNamespace, setParent, sub, swapChildren, swapTrackedComponents, sync, toString, trackComponent, trimify, untrackComponent, validate, validate, validateChild, validateIsChild, validateName, validatePage, validateParent, wireController, wireController

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.IElementIdentifier

transformForClient

Methods inherited from interface org.fujion.common.IAttributeMap

getAttribute, hasAttribute, removeAttribute, setAttribute

Constructor Detail

Tab

public Tab()

Tab

public Tab(String label)

Method Detail

isClosable

@Component.PropertyGetter(value="closable",
                          description="True if the tab is closable. A closable tab has an icon that, when clicked, removes and destroys the tab.")
public boolean isClosable()

Returns true if the tab is closable. A closable tab has an icon that, when clicked, removes and destroys the tab.

Returns:

True if the tab is closable.

setClosable

@Component.PropertySetter(value="closable",
                          defaultValue="false",
                          description="True if the tab is closable. A closable tab has an icon that, when clicked, removes and destroys the tab.")
public void setClosable(boolean closable)

Set to true to make the tab closable. A tab that is closable has an icon that, when clicked, triggers a close event.

Parameters:

closable - If true, the tab is closable.

See Also:

onCanClose

isSelected

@Component.PropertyGetter(value="selected",
                          description="The selection state of the tab.")
public boolean isSelected()

Returns the selection state of the tab.

Returns:

The selection state of the tab.

setSelected

@Component.PropertySetter(value="selected",
                          defaultValue="false",
                          description="The selection state of the tab.")
public void setSelected(boolean selected)

Sets the selection state of the tab.

Parameters:

selected - The selection state of the tab.

_setSelected

protected void _setSelected(boolean selected,
                            boolean notifyParent)

Sets the tabs selected status.

Parameters:

selected - The new selected status.

notifyParent - If true, notify the parent tab view of the status change.

close

public boolean close()

Request the tab to be closed. Tab closure may be prevented if the onCanClose logic returns false.

Returns:

True if the tab was closed.

canClose

public boolean canClose()

Invokes the canClose logic and returns the result.

Returns:

The result of invoking the canClose logic.

getTabview

public Tabview getTabview()

getOnCanClose

public BooleanSupplier getOnCanClose()

Returns the functional interface that determines whether tab closure is permitted.

Returns:

The functional interface that determines whether tab closure is permitted.

setOnCanClose

public void setOnCanClose(boolean canClose)

Sets whether tab closure is permitted using a simple Boolean value. This is a shortcut for calling setOnCanClose(boolean) with a functional interface that returns a fixed Boolean value.

Parameters:

canClose - If true, the tab may be closed.

setOnCanClose

public void setOnCanClose(BooleanSupplier onCanClose)

Sets the functional interface that will determine if tab closure is permitted.

Parameters:

onCanClose - The functional interface that will determine if tab closure is permitted.

bringToFront

public void bringToFront()

Description copied from class: BaseComponent

Override to cause a UI component to be brought to the forefront of the UI.

Overrides:

bringToFront in class BaseComponent