Class Layer

java.lang.Object

ch.nolix.system.element.mutableelement.AbstractMutableElement

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

ch.nolix.system.webgui.main.Layer

All Implemented Interfaces:

IFluentMutableMultiTokenHolder<Layer>, IFluentMutableOptionalIdHolder<Layer>, IMultiTokenHolder, IOptionalIdHolder, IGuiComponent<IWebGui<?>>, TypeRequestable, Clearable, Resettable, EmptinessRequestable, IHtmlGetter, IElement, IStructureElement, IMutableElement, IBackgroundHolder<Layer>, IStylableElement<Layer>, ILayer<Layer>, IRootControlOwner<Layer>

public final class Layer
extends AbstractStylableElement<Layer>
implements ILayer<Layer>

Author:

Silvan Wyss

Field Summary

Fields

Modifier and Type	Field	Description
static final IColor	DEFAULT_BACKGROUND_COLOR
static final ContentAlignment	DEFAULT_CONTENT_POSITION
static final double	DEFAULT_OPACITY

Constructor Summary

Constructors

Constructor	Description
Layer()

Method Summary

Modifier and Type	Method	Description
boolean	belongsToGui()
void	clear()	Removes the elements of the current Clearable.
boolean	containsControl(IControl<?,?> control)
static Layer	fromSpecification(INode<?> specification)
IBackground	getBackground()
IColor	getBackgroundColor()
IColorGradient	getBackgroundColorGradient()
IImage	getBackgroundImage()
ImageApplication	getBackgroundImageApplication()
BackgroundType	getBackgroundType()
ContentAlignment	getContentAlignment()
ICssRule	getCssRule()
IHtmlElement	getHtml()
String	getInternalId()
double	getOpacity()
Optional<IControl<?,?>>	getOptionalStoredControlByInternalId(String internalId)
LayerRole	getRole()
IContainer<? extends IStylableElement<?>>	getStoredChildStylableElements()
IContainer<IControl<?,?>>	getStoredControls()
IWebGui<?>	getStoredParentGui()
IControl<?,?>	getStoredRootControl()
boolean	hasBackground()
boolean	hasInternalId(String internalId)
boolean	hasRole()
boolean	hasRole(String role)
void	internalSetParentGui(IWebGui<?> parentGui)
boolean	isEmpty()
void	removeBackground()
void	removeRole()
void	removeSelfFromGui()
Layer	setBackground(IBackground background)
Layer	setBackgroundColor(IColor backgroundColor)
Layer	setBackgroundColorGradient(IColorGradient backgroundColorGradient)
Layer	setBackgroundImage(IImage backgroundImage)
Layer	setBackgroundImage(IImage backgroundImage, ImageApplication imageApplication)
Layer	setContentAlignment(ContentAlignment contentAlignment)
Layer	setOpacity(double opacity)
Layer	setRole(LayerRole role)
Layer	setRootControl(IControl<?,?> rootControl)

Methods inherited from class AbstractStylableElement

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

Methods inherited from class AbstractMutableElement

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface EmptinessRequestable

containsAny

Methods inherited from interface IElement

getAttributes, getSpecification, toFormatedString, toXml

Methods inherited from interface IFluentMutableMultiTokenHolder

addToken, removeToken, removeTokens

Methods inherited from interface IFluentMutableOptionalIdHolder

removeId, setId

Methods inherited from interface IMultiTokenHolder

getTokens

Methods inherited from interface IMutableElement

addOrChangeAttribute, addOrChangeAttribute, addOrChangeAttributes, addOrChangeAttributes, addOrChangeAttributes, resetFromAttributes, resetFromSpecification

Methods inherited from interface IOptionalIdHolder

getId, getIdInQuotes, hasId, hasId

Methods inherited from interface IStructureElement

getChildStructureElements

Methods inherited from interface IStylableElement

resetStyleRecursively

Methods inherited from interface Resettable

reset

Methods inherited from interface TypeRequestable

getType, isOfConcreteType, isOfConcreteType, isOfType, isOfType

Field Details

DEFAULT_OPACITY

public static final double DEFAULT_OPACITY

See Also:

• Constant Field Values

DEFAULT_BACKGROUND_COLOR

public static final IColor DEFAULT_BACKGROUND_COLOR

DEFAULT_CONTENT_POSITION

public static final ContentAlignment DEFAULT_CONTENT_POSITION

Constructor Details

Layer

public Layer()

Method Details

fromSpecification

public static Layer fromSpecification(INode<?> specification)

belongsToGui

public boolean belongsToGui()

Specified by:

belongsToGui in interface IGuiComponent<IWebGui<?>>

Returns:

true if the current IGuiComponent belongs to a GUI, false otherwise.

containsControl

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

Specified by:

containsControl in interface ILayer<Layer>

clear

public void clear()

Removes the elements of the current Clearable.

Specified by:

clear in interface Clearable

getBackground

public IBackground getBackground()

Specified by:

getBackground in interface IBackgroundHolder<Layer>

getBackgroundColor

public IColor getBackgroundColor()

Specified by:

getBackgroundColor in interface IBackgroundHolder<Layer>

getBackgroundColorGradient

public IColorGradient getBackgroundColorGradient()

Specified by:

getBackgroundColorGradient in interface IBackgroundHolder<Layer>

getBackgroundImage

public IImage getBackgroundImage()

Specified by:

getBackgroundImage in interface IBackgroundHolder<Layer>

getBackgroundImageApplication

public ImageApplication getBackgroundImageApplication()

Specified by:

getBackgroundImageApplication in interface IBackgroundHolder<Layer>

getBackgroundType

public BackgroundType getBackgroundType()

Specified by:

getBackgroundType in interface IBackgroundHolder<Layer>

getContentAlignment

public ContentAlignment getContentAlignment()

Specified by:

getContentAlignment in interface ILayer<Layer>

getCssRule

public ICssRule getCssRule()

Specified by:

getCssRule in interface ILayer<Layer>

getHtml

public IHtmlElement getHtml()

Specified by:

getHtml in interface IHtmlGetter

getInternalId

public String getInternalId()

Specified by:

getInternalId in interface ILayer<Layer>

getOpacity

public double getOpacity()

Specified by:

getOpacity in interface ILayer<Layer>

getOptionalStoredControlByInternalId

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

Specified by:

getOptionalStoredControlByInternalId in interface IRootControlOwner<Layer>

getStoredControls

public IContainer<IControl<?,?>> getStoredControls()

Specified by:

getStoredControls in interface IRootControlOwner<Layer>

getStoredParentGui

public IWebGui<?> getStoredParentGui()

Specified by:

getStoredParentGui in interface IGuiComponent<IWebGui<?>>

Returns:

the GUI of the current IGuiComponent.

getStoredRootControl

public IControl<?,?> getStoredRootControl()

Specified by:

getStoredRootControl in interface IRootControlOwner<Layer>

getRole

public LayerRole getRole()

Specified by:

getRole in interface ILayer<Layer>

getStoredChildStylableElements

public IContainer<? extends IStylableElement<?>> getStoredChildStylableElements()

Specified by:

getStoredChildStylableElements in interface IStylableElement<Layer>

Returns:

the child IStylableElements of the current IStylableElement.

hasBackground

public boolean hasBackground()

Specified by:

hasBackground in interface IBackgroundHolder<Layer>

hasInternalId

public boolean hasInternalId(String internalId)

Specified by:

hasInternalId in interface ILayer<Layer>

hasRole

public boolean hasRole()

Specified by:

hasRole in interface ILayer<Layer>

hasRole

public boolean hasRole(String role)

Specified by:

hasRole in interface IStylableElement<Layer>

Parameters:

role -

Returns:

true if the current IStylableElement has the given role, false otherwise.

internalSetParentGui

public void internalSetParentGui(IWebGui<?> parentGui)

Specified by:

internalSetParentGui in interface ILayer<Layer>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface EmptinessRequestable

Returns:

true if EmptinessRequestable does not contain an element, false otherwise.

removeBackground

public void removeBackground()

Specified by:

removeBackground in interface IBackgroundHolder<Layer>

removeRole

public void removeRole()

removeSelfFromGui

public void removeSelfFromGui()

Specified by:

removeSelfFromGui in interface ILayer<Layer>

setBackground

public Layer setBackground(IBackground background)

setBackgroundColor

public Layer setBackgroundColor(IColor backgroundColor)

Specified by:

setBackgroundColor in interface IBackgroundHolder<Layer>

setBackgroundColorGradient

public Layer setBackgroundColorGradient(IColorGradient backgroundColorGradient)

Specified by:

setBackgroundColorGradient in interface IBackgroundHolder<Layer>

setBackgroundImage

public Layer setBackgroundImage(IImage backgroundImage)

Specified by:

setBackgroundImage in interface IBackgroundHolder<Layer>

setBackgroundImage

public Layer setBackgroundImage(IImage backgroundImage,
 ImageApplication imageApplication)

Specified by:

setBackgroundImage in interface IBackgroundHolder<Layer>

setRootControl

public Layer setRootControl(IControl<?,?> rootControl)

Specified by:

setRootControl in interface IRootControlOwner<Layer>

setContentAlignment

public Layer setContentAlignment(ContentAlignment contentAlignment)

Specified by:

setContentAlignment in interface ILayer<Layer>

setOpacity

public Layer setOpacity(double opacity)

Specified by:

setOpacity in interface ILayer<Layer>

setRole

public Layer setRole(LayerRole role)

Specified by:

setRole in interface ILayer<Layer>