Class WebGui

java.lang.Object

ch.nolix.system.element.mutableelement.AbstractMutableElementWithProperties

ch.nolix.system.style.stylable.AbstractStylableElement<WebGui>

ch.nolix.system.style.stylable.AbstractStyleElement<WebGui>

ch.nolix.system.webgui.main.WebGui

All Implemented Interfaces:

FluentMutableTitleHolder<WebGui>, FluentMutableMultiTokenHolder<WebGui>, FluentMutableOptionalIdHolder<WebGui>, TitleHolder, MultiTokenHolder, OptionalIdHolder, Clearable, Resettable, EmptinessRequestable, TypeRequestable, AttributesRepresentable, Element, SpecificationRepresentable, MutableElement, BackgroundManager<WebGui>, FluentMutableIconHolder<WebGui>, IconHolder, Gui<WebGui>, StylableElement<WebGui>, StyleHolder<WebGui>, IWebGui<WebGui>

public final class WebGui
extends AbstractStyleElement<WebGui>
implements IWebGui<WebGui>

Author:

Silvan Wyss

Field Summary

Fields

Modifier and Type	Field	Description
static final Color	DEFAULT_BACKGROUND_COLOR
static final ImmutableImage	DEFAULT_ICON
static final String	DEFAULT_TITLE

Constructor Summary

Constructors

Constructor	Description
WebGui()

Method Summary

Modifier and Type	Method	Description
void	clear()	Removes the elements of the current Clearable.
boolean	containsControl(Control<?,?> control)
IFrontEndReader	fromFrontEnd()
IBackground	getBackground()
IColor	getBackgroundColor()
IColorGradient	getBackgroundColorGradient()
Image	getBackgroundImage()
ImageApplication	getBackgroundImageApplication()
BackgroundType	getBackgroundType()
ICss	getCss()
IHtmlElement	getHtml()
ExtendedIterable<IHtmlElementEvent>	getHtmlElementEventRegistrations()
Image	getIcon()
int	getLayerCount()
Optional<Control<?,?>>	getOptionalStoredControlByInternalId(String internalId)
ExtendedIterable<? extends StylableElement<?>>	getStoredChildStylableElements()
ExtendedIterable<Control<?,?>>	getStoredControls()
ExtendedIterable<ILayer>	getStoredLayers()
ExtendedIterable<Control<?,?>>	getStoredStructureControls()
ILayer	getStoredTopLayer()
String	getTitle()
boolean	hasBackground()
boolean	hasRemoveLayerAction()
boolean	hasRole(String role)
boolean	isEmpty()
IFrontEndWriter	onFrontEnd()
WebGui	pushLayer(ILayer layer)
WebGui	pushLayerWithRootControl(Control<?,?> rootControl)
void	removeBackground()
void	removeLayer(ILayer layer)
WebGui	setBackground(IBackground background)
WebGui	setBackgroundColor(IColor backgroundColor)
WebGui	setBackgroundColorGradient(IColorGradient backgroundColorGradient)
WebGui	setBackgroundImage(Image backgroundImage)
WebGui	setBackgroundImage(Image backgroundImage, ImageApplication imageApplication)
WebGui	setFrontEndReaderAndFrontEndWriter(IFrontEndReader frontEndReader, IFrontEndWriter frontEndWriter)
WebGui	setIcon(Image icon)	Sets the icon of the current FluentMutableIconHolder.
WebGui	setRemoveLayerAction(Runnable removeLayerAction)
WebGui	setTitle(String title)	Sets the title of the current FluentMutableTitleHolder.

Methods inherited from class AbstractStyleElement

applyStyleIfHasStyle, hasStyle, removeStyle, setStyle

Methods inherited from class AbstractStylableElement

addToken, getId, getTokens, hasId, removeId, removeToken, removeTokens, reset, resetStyleRecursively, setId

Methods inherited from class AbstractMutableElementWithProperties

addOrChangeAttribute, addOrChangeAttribute, equals, getAttributes, getSpecification, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AttributesRepresentable

getAttributes

Methods inherited from interface EmptinessRequestable

containsAny

Methods inherited from interface FluentMutableMultiTokenHolder

addToken, removeToken, removeTokens

Methods inherited from interface FluentMutableOptionalIdHolder

removeId, setId

Methods inherited from interface MultiTokenHolder

getTokens

Methods inherited from interface MutableElement

addOrChangeAttribute, addOrChangeAttribute, addOrChangeAttributes, resetFromAttributes, resetFromSpecification

Methods inherited from interface OptionalIdHolder

getId, getIdInSingleQuotes, hasId, hasId

Methods inherited from interface Resettable

reset

Methods inherited from interface SpecificationRepresentable

getSpecification, hasEqualSpecificationAsElement, toFormatedString

Methods inherited from interface StylableElement

resetStyleRecursively

Methods inherited from interface StyleHolder

applyStyleIfHasStyle, hasStyle, removeStyle, setStyle

Methods inherited from interface TitleHolder

getTitleInSingleQuotes

Methods inherited from interface TypeRequestable

getType, isOfConcreteType, isOfConcreteType, isOfType, isOfType

Field Details

DEFAULT_TITLE

public static final String DEFAULT_TITLE

See Also:

• Constant Field Values

DEFAULT_ICON

public static final ImmutableImage DEFAULT_ICON

DEFAULT_BACKGROUND_COLOR

public static final Color DEFAULT_BACKGROUND_COLOR

Constructor Details

WebGui

public WebGui()

Method Details

containsControl

public boolean containsControl(Control<?,?> control)

Specified by:

containsControl in interface IWebGui<WebGui>

clear

public void clear()

Removes the elements of the current Clearable.

Specified by:

clear in interface Clearable

fromFrontEnd

public IFrontEndReader fromFrontEnd()

Specified by:

fromFrontEnd in interface Gui<WebGui>

Returns:

the IFrontEndReader of the current Gui

getBackground

public IBackground getBackground()

Specified by:

getBackground in interface BackgroundManager<WebGui>

getBackgroundColor

public IColor getBackgroundColor()

Specified by:

getBackgroundColor in interface BackgroundManager<WebGui>

getBackgroundColorGradient

public IColorGradient getBackgroundColorGradient()

Specified by:

getBackgroundColorGradient in interface BackgroundManager<WebGui>

getBackgroundImage

public Image getBackgroundImage()

Specified by:

getBackgroundImage in interface BackgroundManager<WebGui>

getBackgroundImageApplication

public ImageApplication getBackgroundImageApplication()

Specified by:

getBackgroundImageApplication in interface BackgroundManager<WebGui>

getBackgroundType

public BackgroundType getBackgroundType()

Specified by:

getBackgroundType in interface BackgroundManager<WebGui>

getCss

public ICss getCss()

Specified by:

getCss in interface IWebGui<WebGui>

getHtml

public IHtmlElement getHtml()

Specified by:

getHtml in interface IWebGui<WebGui>

getIcon

public Image getIcon()

Specified by:

getIcon in interface IconHolder

Returns:

the icon of the current IconHolder

getHtmlElementEventRegistrations

public ExtendedIterable<IHtmlElementEvent> getHtmlElementEventRegistrations()

Specified by:

getHtmlElementEventRegistrations in interface IWebGui<WebGui>

getLayerCount

public int getLayerCount()

Specified by:

getLayerCount in interface IWebGui<WebGui>

getOptionalStoredControlByInternalId

public Optional<Control<?,?>> getOptionalStoredControlByInternalId(String internalId)

Specified by:

getOptionalStoredControlByInternalId in interface IWebGui<WebGui>

getStoredChildStylableElements

public ExtendedIterable<? extends StylableElement<?>> getStoredChildStylableElements()

Specified by:

getStoredChildStylableElements in interface StylableElement<WebGui>

Returns:

the child StylableElements of the current StylableElement.

getStoredControls

public ExtendedIterable<Control<?,?>> getStoredControls()

Specified by:

getStoredControls in interface IWebGui<WebGui>

getStoredLayers

public ExtendedIterable<ILayer> getStoredLayers()

Specified by:

getStoredLayers in interface IWebGui<WebGui>

getStoredStructureControls

public ExtendedIterable<Control<?,?>> getStoredStructureControls()

Specified by:

getStoredStructureControls in interface IWebGui<WebGui>

getStoredTopLayer

public ILayer getStoredTopLayer()

Specified by:

getStoredTopLayer in interface IWebGui<WebGui>

getTitle

public String getTitle()

Specified by:

getTitle in interface TitleHolder

Returns:

the title of the current TitleHolder

hasBackground

public boolean hasBackground()

Specified by:

hasBackground in interface BackgroundManager<WebGui>

hasRemoveLayerAction

public boolean hasRemoveLayerAction()

Specified by:

hasRemoveLayerAction in interface IWebGui<WebGui>

hasRole

public boolean hasRole(String role)

Specified by:

hasRole in interface StylableElement<WebGui>

Parameters:

role -

Returns:

true if the current StylableElement has the given role, false otherwise

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface EmptinessRequestable

Returns:

true if EmptinessRequestable does not contain an element, false otherwise

onFrontEnd

public IFrontEndWriter onFrontEnd()

Specified by:

onFrontEnd in interface Gui<WebGui>

Returns:

the IFrontEndWriter of the current Gui

pushLayer

public WebGui pushLayer(ILayer layer)

Specified by:

pushLayer in interface IWebGui<WebGui>

pushLayerWithRootControl

public WebGui pushLayerWithRootControl(Control<?,?> rootControl)

Specified by:

pushLayerWithRootControl in interface IWebGui<WebGui>

removeBackground

public void removeBackground()

Specified by:

removeBackground in interface BackgroundManager<WebGui>

removeLayer

public void removeLayer(ILayer layer)

Specified by:

removeLayer in interface IWebGui<WebGui>

setBackground

public WebGui setBackground(IBackground background)

setBackgroundColor

public WebGui setBackgroundColor(IColor backgroundColor)

Specified by:

setBackgroundColor in interface BackgroundManager<WebGui>

setBackgroundColorGradient

public WebGui setBackgroundColorGradient(IColorGradient backgroundColorGradient)

Specified by:

setBackgroundColorGradient in interface BackgroundManager<WebGui>

setBackgroundImage

public WebGui setBackgroundImage(Image backgroundImage)

Specified by:

setBackgroundImage in interface BackgroundManager<WebGui>

setBackgroundImage

public WebGui setBackgroundImage(Image backgroundImage,
 ImageApplication imageApplication)

Specified by:

setBackgroundImage in interface BackgroundManager<WebGui>

setFrontEndReaderAndFrontEndWriter

public WebGui setFrontEndReaderAndFrontEndWriter(IFrontEndReader frontEndReader,
 IFrontEndWriter frontEndWriter)

Specified by:

setFrontEndReaderAndFrontEndWriter in interface IWebGui<WebGui>

setIcon

public WebGui setIcon(Image icon)

Sets the icon of the current FluentMutableIconHolder.

Specified by:

setIcon in interface FluentMutableIconHolder<WebGui>

Parameters:

icon -

Returns:

the current FluentMutableIconHolder

setRemoveLayerAction

public WebGui setRemoveLayerAction(Runnable removeLayerAction)

Specified by:

setRemoveLayerAction in interface IWebGui<WebGui>

setTitle

public WebGui setTitle(String title)

Sets the title of the current FluentMutableTitleHolder.

Specified by:

setTitle in interface FluentMutableTitleHolder<WebGui>

Parameters:

title -

Returns:

the current FluentMutableTitleHolder