Package org.teamapps.ux.component.panel

Class Panel

java.lang.Object

org.teamapps.ux.component.AbstractComponent

org.teamapps.ux.component.panel.Panel

All Implemented Interfaces:

Component, Container

Direct Known Subclasses:

Window

public class Panel
extends AbstractComponent
implements Container

Field Summary

Fields

Modifier and Type	Field	Description
Event<WindowButtonType>	onWindowButtonClicked

Fields inherited from class org.teamapps.ux.component.AbstractComponent

onDestroyed, onRendered

Constructor Summary

Constructors

Constructor	Description
Panel()
Panel(org.teamapps.icons.api.Icon icon, java.lang.String title)
Panel(org.teamapps.icons.api.Icon icon, java.lang.String title, Component content)

Method Summary

Modifier and Type	Method	Description
void	addToolButton(ToolButton toolButton)
org.teamapps.dto.UiComponent	createUiComponent()
org.teamapps.dto.UiPanelHeaderField	createUiPanelHeaderField(AbstractField<?> field, org.teamapps.icons.api.Icon icon, int minWidth, int maxWidth)
protected void	doDestroy()	Override this method to release resources whenever this component gets destroyed
Component	getContent()
HeaderComponentMinimizationPolicy	getHeaderComponentMinimizationPolicy()
org.teamapps.icons.api.Icon	getIcon()
AbstractField<?>	getLeftHeaderField()
org.teamapps.icons.api.Icon	getLeftHeaderFieldIcon()
int	getLeftHeaderFieldMaxWidth()
int	getLeftHeaderFieldMinWidth()
int	getPadding()
AbstractField<?>	getRightHeaderField()
org.teamapps.icons.api.Icon	getRightHeaderFieldIcon()
int	getRightHeaderFieldMaxWidth()
int	getRightHeaderFieldMinWidth()
java.lang.String	getTitle()
Toolbar	getToolbar()
java.util.List<ToolButton>	getToolButtons()
java.util.Set<WindowButtonType>	getWindowButtons()
void	handleUiEvent(org.teamapps.dto.UiEvent event)
boolean	isAlwaysShowHeaderFieldIcons()
boolean	isChildVisible(Component child)
boolean	isHideTitleBar()
boolean	isMaximizable()
boolean	isStretchContent()
protected void	mapUiPanelProperties(org.teamapps.dto.UiPanel uiPanel)
void	removeToolButton(ToolButton toolButton)
void	setAlwaysShowHeaderFieldIcons(boolean alwaysShowHeaderFieldIcons)
void	setBodyBackgroundColor(org.teamapps.common.format.Color bodyBackgroundColor)
void	setContent(Component content)
void	setHeaderBackgroundColor(org.teamapps.common.format.Color headerBackgroundColor)
void	setHeaderComponentMinimizationPolicy(HeaderComponentMinimizationPolicy headerComponentMinimizationPolicy)
void	setHeaderFontColor(org.teamapps.common.format.Color headerFontColor)
void	setHideTitleBar(boolean hideTitleBar)
void	setIcon(org.teamapps.icons.api.Icon icon)
void	setLeftHeaderField(AbstractField<?> leftHeaderField)
Panel	setLeftHeaderField(AbstractField<?> field, org.teamapps.icons.api.Icon icon, int minWidth, int maxWidth)
void	setLeftHeaderFieldIcon(org.teamapps.icons.api.Icon leftHeaderFieldIcon)
void	setLeftHeaderFieldMaxWidth(int leftHeaderFieldMaxWidth)
void	setLeftHeaderFieldMinWidth(int leftHeaderFieldMinWidth)
void	setMaximizable(boolean maximizable)
void	setPadding(int padding)
void	setRightHeaderField(AbstractField<?> rightHeaderField)
Panel	setRightHeaderField(AbstractField<?> field, org.teamapps.icons.api.Icon icon, int minWidth, int maxWidth)
void	setRightHeaderFieldIcon(org.teamapps.icons.api.Icon rightHeaderFieldIcon)
void	setRightHeaderFieldMaxWidth(int rightHeaderFieldMaxWidth)
void	setRightHeaderFieldMinWidth(int rightHeaderFieldMinWidth)
void	setStretchContent(boolean stretchContent)
void	setTitle(java.lang.String title)
void	setToolbar(Toolbar toolbar)
void	setToolButtons(java.util.List<ToolButton> toolButtons)
void	setWindowButtons(java.util.Collection<WindowButtonType> buttons)

Methods inherited from class org.teamapps.ux.component.AbstractComponent

createUiComponentReference, destroy, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, isVisible, mapAbstractUiComponentProperties, onDestroyed, queueCommandIfRendered, render, reRenderIfRendered, setCssStyle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, setVisible, toString, 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

createUiComponentReference, destroy, getId, getParent, getSessionContext, isDestroyed, isEffectivelyVisible, isRendered, isVisible, onDestroyed, render, setCssStyle, setCssStyle, setMargin, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setParent, setShadow, setVisible, unrender

Field Detail

onWindowButtonClicked

public final Event<WindowButtonType> onWindowButtonClicked

Constructor Detail

Panel

public Panel()

Panel

public Panel(org.teamapps.icons.api.Icon icon,
             java.lang.String title)

Panel

public Panel(org.teamapps.icons.api.Icon icon,
             java.lang.String title,
             Component content)

Method Detail

doDestroy

protected void doDestroy()

Description copied from class: AbstractComponent

Override this method to release resources whenever this component gets destroyed

Overrides:

doDestroy in class AbstractComponent

addToolButton

public void addToolButton(ToolButton toolButton)

removeToolButton

public void removeToolButton(ToolButton toolButton)

setToolButtons

public void setToolButtons(java.util.List<ToolButton> toolButtons)

getToolButtons

public java.util.List<ToolButton> getToolButtons()

setWindowButtons

public void setWindowButtons(java.util.Collection<WindowButtonType> buttons)

getWindowButtons

public java.util.Set<WindowButtonType> getWindowButtons()

createUiComponent

public org.teamapps.dto.UiComponent createUiComponent()

Specified by:

createUiComponent in class AbstractComponent

mapUiPanelProperties

protected void mapUiPanelProperties(org.teamapps.dto.UiPanel uiPanel)

createUiPanelHeaderField

public org.teamapps.dto.UiPanelHeaderField createUiPanelHeaderField(AbstractField<?> field,
                                                                    org.teamapps.icons.api.Icon icon,
                                                                    int minWidth,
                                                                    int maxWidth)

setLeftHeaderField

public Panel setLeftHeaderField(AbstractField<?> field,
                                org.teamapps.icons.api.Icon icon,
                                int minWidth,
                                int maxWidth)

getLeftHeaderField

public AbstractField<?> getLeftHeaderField()

setRightHeaderField

public Panel setRightHeaderField(AbstractField<?> field,
                                 org.teamapps.icons.api.Icon icon,
                                 int minWidth,
                                 int maxWidth)

getRightHeaderField

public AbstractField<?> getRightHeaderField()

setContent

public void setContent(Component content)

handleUiEvent

public void handleUiEvent(org.teamapps.dto.UiEvent event)

Specified by:

handleUiEvent in interface Component

getTitle

public java.lang.String getTitle()

setTitle

public void setTitle(java.lang.String title)

getIcon

public org.teamapps.icons.api.Icon getIcon()

setIcon

public void setIcon(org.teamapps.icons.api.Icon icon)

getContent

public Component getContent()

setHeaderBackgroundColor

public void setHeaderBackgroundColor(org.teamapps.common.format.Color headerBackgroundColor)

setHeaderFontColor

public void setHeaderFontColor(org.teamapps.common.format.Color headerFontColor)

setBodyBackgroundColor

public void setBodyBackgroundColor(org.teamapps.common.format.Color bodyBackgroundColor)

getHeaderComponentMinimizationPolicy

public HeaderComponentMinimizationPolicy getHeaderComponentMinimizationPolicy()

setHeaderComponentMinimizationPolicy

public void setHeaderComponentMinimizationPolicy(HeaderComponentMinimizationPolicy headerComponentMinimizationPolicy)

isHideTitleBar

public boolean isHideTitleBar()

setHideTitleBar

public void setHideTitleBar(boolean hideTitleBar)

getToolbar

public Toolbar getToolbar()

setToolbar

public void setToolbar(Toolbar toolbar)

getPadding

public int getPadding()

setPadding

public void setPadding(int padding)

isMaximizable

public boolean isMaximizable()

setMaximizable

public void setMaximizable(boolean maximizable)

isChildVisible

public boolean isChildVisible(Component child)

Specified by:

isChildVisible in interface Container

setLeftHeaderField

public void setLeftHeaderField(AbstractField<?> leftHeaderField)

getLeftHeaderFieldIcon

public org.teamapps.icons.api.Icon getLeftHeaderFieldIcon()

setLeftHeaderFieldIcon

public void setLeftHeaderFieldIcon(org.teamapps.icons.api.Icon leftHeaderFieldIcon)

getLeftHeaderFieldMinWidth

public int getLeftHeaderFieldMinWidth()

setLeftHeaderFieldMinWidth

public void setLeftHeaderFieldMinWidth(int leftHeaderFieldMinWidth)

getLeftHeaderFieldMaxWidth

public int getLeftHeaderFieldMaxWidth()

setLeftHeaderFieldMaxWidth

public void setLeftHeaderFieldMaxWidth(int leftHeaderFieldMaxWidth)

setRightHeaderField

public void setRightHeaderField(AbstractField<?> rightHeaderField)

getRightHeaderFieldIcon

public org.teamapps.icons.api.Icon getRightHeaderFieldIcon()

setRightHeaderFieldIcon

public void setRightHeaderFieldIcon(org.teamapps.icons.api.Icon rightHeaderFieldIcon)

getRightHeaderFieldMinWidth

public int getRightHeaderFieldMinWidth()

setRightHeaderFieldMinWidth

public void setRightHeaderFieldMinWidth(int rightHeaderFieldMinWidth)

getRightHeaderFieldMaxWidth

public int getRightHeaderFieldMaxWidth()

setRightHeaderFieldMaxWidth

public void setRightHeaderFieldMaxWidth(int rightHeaderFieldMaxWidth)

isAlwaysShowHeaderFieldIcons

public boolean isAlwaysShowHeaderFieldIcons()

setAlwaysShowHeaderFieldIcons

public void setAlwaysShowHeaderFieldIcons(boolean alwaysShowHeaderFieldIcons)

isStretchContent

public boolean isStretchContent()

setStretchContent

public void setStretchContent(boolean stretchContent)