Package org.teamapps.ux.component

Class AbstractComponent

java.lang.Object

org.teamapps.ux.component.AbstractComponent

All Implemented Interfaces:

Component

Direct Known Subclasses:

AbsoluteLayout, AbstractField, AbstractForm, AbstractToolContainer, BootstrapishGridLayout, Calendar, ChatDisplay, ChatInput, DocumentViewer, DummyComponent, ElegantPanel, FlexContainer, Gauge, GroupingView, IFrame, ImageCropper, InfiniteItemView, ItemView, MapView, MediaPlayer, MediaTrackGraph, MobileLayout, NavigationBar, PageView, Panel, PieChart, ResponsiveGridLayout, RootPanel, SplitPane, Table, TabPanel, TimeGraph, ToolButton, Tree, VideoPlayer, WebRtcPlayer, WebRtcPublisher, WorkSpaceLayout

public abstract class AbstractComponent
extends java.lang.Object
implements Component

Field Summary

Fields

Modifier and Type	Field	Description
Event<java.lang.Void>	onDestroyed
Event<java.lang.Void>	onRendered

Constructor Summary

Constructors

Constructor	Description
AbstractComponent()

Method Summary

Modifier and Type	Method	Description
abstract org.teamapps.dto.UiComponent	createUiComponent()
org.teamapps.dto.UiComponentReference	createUiComponentReference()
void	destroy()
protected void	doDestroy()	Override this method to release resources whenever this component gets destroyed
java.lang.String	getId()
Container	getParent()
SessionContext	getSessionContext()
boolean	isDestroyed()
boolean	isEffectivelyVisible()
boolean	isRendered()
boolean	isVisible()
protected void	mapAbstractUiComponentProperties(org.teamapps.dto.UiComponent uiComponent)
protected void	queueCommandIfRendered(java.util.function.Supplier<org.teamapps.dto.UiCommand> commandSupplier)
void	render()
void	reRenderIfRendered()
void	setCssStyle(java.lang.String selector, java.lang.String propertyName, java.lang.String value)
void	setMargin(Spacing margin)
void	setMaxHeight(Length maxHeight)
void	setMaxWidth(Length maxWidth)
void	setMinHeight(Length minHeight)
void	setMinWidth(Length minWidth)
void	setParent(Container container)	Used internally for setting the component's container.
void	setShadow(Shadow shadow)
void	setVisible(boolean visible)
java.lang.String	toString()
void	unrender()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.teamapps.ux.component.Component

handleUiEvent, setCssStyle

Field Detail

onDestroyed

public final Event<java.lang.Void> onDestroyed

onRendered

public final Event<java.lang.Void> onRendered

Constructor Detail

AbstractComponent

public AbstractComponent()

Method Detail

mapAbstractUiComponentProperties

protected void mapAbstractUiComponentProperties(org.teamapps.dto.UiComponent uiComponent)

getId

public java.lang.String getId()

Specified by:

getId in interface Component

getSessionContext

public SessionContext getSessionContext()

Specified by:

getSessionContext in interface Component

isRendered

public boolean isRendered()

Specified by:

isRendered in interface Component

isVisible

public boolean isVisible()

Specified by:

isVisible in interface Component

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in interface Component

isEffectivelyVisible

public boolean isEffectivelyVisible()

Specified by:

isEffectivelyVisible in interface Component

isDestroyed

public boolean isDestroyed()

Specified by:

isDestroyed in interface Component

destroy

public final void destroy()

Specified by:

destroy in interface Component

doDestroy

protected void doDestroy()

Override this method to release resources whenever this component gets destroyed

render

public final void render()

Specified by:

render in interface Component

unrender

public final void unrender()

Specified by:

unrender in interface Component

createUiComponent

public abstract org.teamapps.dto.UiComponent createUiComponent()

createUiComponentReference

public org.teamapps.dto.UiComponentReference createUiComponentReference()

Specified by:

createUiComponentReference in interface Component

reRenderIfRendered

public void reRenderIfRendered()

queueCommandIfRendered

protected void queueCommandIfRendered(java.util.function.Supplier<org.teamapps.dto.UiCommand> commandSupplier)

setMinWidth

public void setMinWidth(Length minWidth)

Specified by:

setMinWidth in interface Component

setMaxWidth

public void setMaxWidth(Length maxWidth)

Specified by:

setMaxWidth in interface Component

setMinHeight

public void setMinHeight(Length minHeight)

Specified by:

setMinHeight in interface Component

setMaxHeight

public void setMaxHeight(Length maxHeight)

Specified by:

setMaxHeight in interface Component

setMargin

public void setMargin(Spacing margin)

Specified by:

setMargin in interface Component

setShadow

public void setShadow(Shadow shadow)

Specified by:

setShadow in interface Component

setCssStyle

public void setCssStyle(java.lang.String selector,
                        java.lang.String propertyName,
                        java.lang.String value)

Specified by:

setCssStyle in interface Component

setParent

public void setParent(Container container)

Description copied from interface: Component

Used internally for setting the component's container. May only be invoked by the new container!!

Specified by:

setParent in interface Component

getParent

public Container getParent()

Specified by:

getParent in interface Component

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object