Package org.teamapps.ux.component

Class AbstractComponent

java.lang.Object

org.teamapps.ux.component.AbstractComponent

All Implemented Interfaces:

ClientObject, Component

Direct Known Subclasses:

AbsoluteLayout, AbstractField, AbstractForm, AbstractInfiniteListComponent, AbstractToolContainer, AudioLevelIndicator, BootstrapishGridLayout, Calendar, ChatDisplay, ChatInput, DefaultMultiProgressDisplay, Div, DocumentViewer, DummyComponent, ElegantPanel, FieldGroup, FlexContainer, FloatingComponent, ForceLayoutGraph, Gauge, GroupingView, HtmlView, IFrame, ImageCropper, InfiniteItemView, ItemView, LinkButton, MapView, MapView2, MediaPlayer, MediaSoupV3WebRtcClient, MediaTrackGraph, MobileLayout, NavigationBar, Notification, NotificationBar, PageView, Panel, PieChart, Popup, ProgressDisplay, QrCodeScanner, ResponsiveGridLayout, RootPanel, ShakaPlayer, SplitPane, TabPanel, TimeGraph, ToolButton, Tree, TreeGraph, VideoPlayer, WorkSpaceLayout

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

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DELETED_ATTRIBUTE
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.UiClientObjectReference	createUiReference()	Creates a ui reference to a client object.
java.lang.String	getDebuggingId()
java.lang.String	getId()
Component	getParent()
SessionContext	getSessionContext()
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()	Deprecated. Use explicit ui commands instead.
void	setAttribute(java.lang.String selector, java.lang.String attributeName, java.lang.String value)
void	setCssStyle(java.lang.String selector, java.lang.String propertyName, java.lang.String value)
void	setDebuggingId(java.lang.String debuggingId)
void	setParent(Component container)	Used internally for setting the component's container.
void	setVisible(boolean visible)
void	toggleCssClass(java.lang.String selector, java.lang.String className, boolean enabled)
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.ClientObject

handleUiEvent, handleUiQuery

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

setAriaLabel, setAttribute, setCssStyle, setHtmlTitle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setShadow, toggleCssClass

Field Detail

DELETED_ATTRIBUTE

public static final java.lang.String DELETED_ATTRIBUTE

See Also:

Constant Field Values

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 ClientObject

getSessionContext

public SessionContext getSessionContext()

isRendered

public boolean isRendered()

Specified by:

isRendered in interface ClientObject

isVisible

public boolean isVisible()

Specified by:

isVisible in interface Component

setVisible

public void setVisible(boolean visible)

Specified by:

setVisible in interface Component

render

public final void render()

Specified by:

render in interface ClientObject

unrender

public final void unrender()

Specified by:

unrender in interface ClientObject

createUiComponent

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

createUiReference

public org.teamapps.dto.UiClientObjectReference createUiReference()

Description copied from interface: ClientObject

Creates a ui reference to a client object. Ui references are just a simple way to reference objects on the client side.

Specified by:

createUiReference in interface ClientObject

reRenderIfRendered

@Deprecated
public void reRenderIfRendered()

Deprecated.

Use explicit ui commands instead.

Completely removes and rerenders the component on the client side, loosing any state that is not reflected on the server side. This method should be regarded as dangerous, since many components depend on state (data caches, user interaction state) that is not controlled by the server and will get lost when invoking this method.

Historically, this method was used as a lazy implementation of changing a configuration option, when this change was not implemented on the client side.

queueCommandIfRendered

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

setCssStyle

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

Specified by:

setCssStyle in interface Component

toggleCssClass

public void toggleCssClass(java.lang.String selector,
                           java.lang.String className,
                           boolean enabled)

Specified by:

toggleCssClass in interface Component

setAttribute

public void setAttribute(java.lang.String selector,
                         java.lang.String attributeName,
                         java.lang.String value)

Specified by:

setAttribute in interface Component

setParent

public void setParent(Component 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 Component getParent()

Specified by:

getParent in interface Component

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDebuggingId

public java.lang.String getDebuggingId()

setDebuggingId

public void setDebuggingId(java.lang.String debuggingId)