The main interface of SpaceVIL environment. More...

Inherits com.spvessel.spacevil.Core.InterfaceItem, com.spvessel.spacevil.Core.InterfaceSize, com.spvessel.spacevil.Core.InterfacePosition, com.spvessel.spacevil.Core.InterfaceEventUpdate, and com.spvessel.spacevil.Core.InterfaceBehavior.

Inherited by com.spvessel.spacevil.BaseItem, and com.spvessel.spacevil.Prototype.

Public Member Functions
void	setHandler (CoreWindow handler)
	Setting the window to which the item will belong. More...

CoreWindow	getHandler ()
	Getting the window to which the item belong. More...

void	setParent (Prototype parent)
	Setting the parent of the item. More...

Prototype	getParent ()
	Getting the parent of the item. More...

void	setConfines ()
	Setting the confines of the item relative to its parent's size and position. More...

void	setConfines (int x0, int x1, int y0, int y1)
	Setting the confines of the item relative to specified bounds. More...

void	setMargin (Indents margin)
	Setting the indents of an item to offset itself relative to its container. More...

void	setMargin (int left, int top, int right, int bottom)
	Setting the indents of an item to offset itself relative to its container. More...

Indents	getMargin ()
	Getting the indents of an item to offset itself relative to its container. More...

void	initElements ()
	Initializing children if this BaseItem is container (com.spvessel.spacevil.Prototype). More...

void	setStyle (Style style)
	Setting a style that describes the appearance of an item. More...

Style	getCoreStyle ()
	Getting the core (only appearance properties without inner styles) style of an item. More...

boolean	isDrawable ()
	Getting the drawable (visibility) status of an item. More...

void	setDrawable (boolean value)
	Setting the drawable (visibility) status of an item. More...

boolean	isVisible ()
	Getting the visibility status of an item. More...

void	setVisible (boolean value)
	Setting the visibility status of an item. More...

boolean	isShadowDrop ()
	Getting the shadow visibility status of an item. More...

void	setShadowDrop (boolean value)
	Setting the shadow visibility status of an item. More...

void	setShadowRadius (int radius)
	Setting the specified blur radius of the shadow. More...

int	getShadowRadius ()
	Getting the shadow blur raduis. More...

Color	getShadowColor ()
	Getting shadow color. More...

void	setShadowColor (Color color)
	Setting shadow color. More...

Position	getShadowPos ()
	Getting the offset of the shadow relative to the position of the item. More...

int[]	getShadowExtension ()
	Getting the values of shadow extensions in pixels. More...

void	setShadow (int radius, int x, int y, Color color)
	Setting the shadow with specified blur radius, axis shifts, shadow color. More...

void	release ()
	Method to describe disposing item's resources if the item was removed. More...

Public Member Functions inherited from com.spvessel.spacevil.Core.InterfaceItem
void	setItemName (String name)
	Method for setting the name of the item. More...

String	getItemName ()
	Method for getting the name of the item. More...

void	setBackground (Color color)
	Method for setting background color. More...

Color	getBackground ()
	Method for getting background color. More...

List< float[]>	getTriangles ()
	Method for getting triangles of item's shape. More...

void	setTriangles (List< float[]> triangles)
	Method for setting triangles as item's shape. More...

void	makeShape ()
	Method for making default item's shape. More...

Public Member Functions inherited from com.spvessel.spacevil.Core.InterfaceSize
void	setSize (int width, int height)
	Method setting size of an item's shape. More...

Size	getSize ()
	Method getting size of an item's shape. More...

void	setMinWidth (int width)
	Method setting the minimum width limit. More...

void	setWidth (int width)
	Method setting item width. More...

void	setMaxWidth (int width)
	Method setting the maximum width limit. More...

int	getMinWidth ()
	Method getting the minimum width limit. More...

int	getWidth ()
	Method fetting item width. More...

int	getMaxWidth ()
	Method getting the maximum width limit. More...

void	setMinHeight (int height)
	Method for setting the minimum height limit. More...

void	setHeight (int height)
	Method for setting item height. More...

void	setMaxHeight (int height)
	Method for setting the maximum height limit. More...

int	getMinHeight ()
	Method for getting the minimum height limit. More...

int	getHeight ()
	Method for getting item height. More...

int	getMaxHeight ()
	Method for getting the maximum height limit. More...

Public Member Functions inherited from com.spvessel.spacevil.Core.InterfacePosition
void	setX (int x)
	Method for setting X coordinate of the left-top corner of a shape. More...

int	getX ()
	Method for getting X coordinate of the left-top corner of a shape. More...

void	setY (int y)
	Method for setting Y coordinate of the left-top corner of a shape. More...

int	getY ()
	Method for getting Y coordinate of the left-top corner of a shape. More...

Public Member Functions inherited from com.spvessel.spacevil.Core.InterfaceEventUpdate
void	update (GeometryEventType type, int value)
	Method for updating an item size or/and position. More...

Public Member Functions inherited from com.spvessel.spacevil.Core.InterfaceBehavior
void	setAlignment (ItemAlignment... alignment)
	Setting an alignment of an item's shape relative to its container. More...

List< ItemAlignment >	getAlignment ()
	Getting an alignment of an item's shape relative to its container. More...

void	setWidthPolicy (SizePolicy policy)
	Setting width policy of an item's shape. More...

SizePolicy	getWidthPolicy ()
	Getting width policy of an item's shape.Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...

void	setHeightPolicy (SizePolicy policy)
	Setting height policy of an item's shape. More...

SizePolicy	getHeightPolicy ()
	Getting height policy of an item's shape.Can be Fixed (shape not changes its size) or Expand (shape is stretched to all available space). More...

Detailed Description

The main interface of SpaceVIL environment.

Contains all the necessary methods for rendering objects and interacting with them.

Implementations: BaseItem, Prototype, Primitive.

Member Function Documentation

◆ getCoreStyle()

Style com.spvessel.spacevil.Core.InterfaceBaseItem.getCoreStyle ( )

Getting the core (only appearance properties without inner styles) style of an item.

Returns: Style as com.spvessel.spacevil.Decorations.Style.

Implemented in com.spvessel.spacevil.Prototype, com.spvessel.spacevil.BaseItem, and com.spvessel.spacevil.Primitive.

◆ getHandler()

CoreWindow com.spvessel.spacevil.Core.InterfaceBaseItem.getHandler ( )

Getting the window to which the item belong.

Returns: Window as com.spvessel.spacevil.CoreWindow.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ getMargin()

Indents com.spvessel.spacevil.Core.InterfaceBaseItem.getMargin ( )

Getting the indents of an item to offset itself relative to its container.

Returns: Margin as com.spvessel.spacevil.Decorations.Indents.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ getParent()

Prototype com.spvessel.spacevil.Core.InterfaceBaseItem.getParent ( )

Getting the parent of the item.

Returns: Parent as com.spvessel.spacevil.Prototype (Prototype is container and can contains children).

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ getShadowColor()

Color com.spvessel.spacevil.Core.InterfaceBaseItem.getShadowColor ( )

Getting shadow color.

Returns: Returns the shadow color as java.awt.Color.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ getShadowExtension()

int [] com.spvessel.spacevil.Core.InterfaceBaseItem.getShadowExtension ( )

Getting the values of shadow extensions in pixels.

Returns: The values of shadow extensions.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ getShadowPos()

Position com.spvessel.spacevil.Core.InterfaceBaseItem.getShadowPos ( )

Getting the offset of the shadow relative to the position of the item.

Returns: Shadow offset as com.spvessel.spacevil.Core.Position.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ getShadowRadius()

int com.spvessel.spacevil.Core.InterfaceBaseItem.getShadowRadius ( )

Getting the shadow blur raduis.

Returns: The blur radius of the shadow.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ initElements()

void com.spvessel.spacevil.Core.InterfaceBaseItem.initElements ( )

Initializing children if this BaseItem is container (com.spvessel.spacevil.Prototype).

◆ isDrawable()

boolean com.spvessel.spacevil.Core.InterfaceBaseItem.isDrawable ( )

Getting the drawable (visibility) status of an item.

This property used in conjunction with the isVisible() property.

Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: com.spvessel.spacevil.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: com.spvessel.spacevil.TreeView).

Returns: True: if item is drawable (visible). False: if item is not drawable (invisible).

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ isShadowDrop()

boolean com.spvessel.spacevil.Core.InterfaceBaseItem.isShadowDrop ( )

Getting the shadow visibility status of an item.

Returns: True: if shadow is visible. False: if shadow is invisible.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ isVisible()

boolean com.spvessel.spacevil.Core.InterfaceBaseItem.isVisible ( )

Getting the visibility status of an item.

This property may used in conjunction with the isDrawable() property.

Returns: True: if item is visible. False: if item is invisible.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ release()

void com.spvessel.spacevil.Core.InterfaceBaseItem.release ( )

Method to describe disposing item's resources if the item was removed.

Implemented in com.spvessel.spacevil.BaseItem, com.spvessel.spacevil.ImageItem, com.spvessel.spacevil.Tab, com.spvessel.spacevil.Prototype, com.spvessel.spacevil.DialogItem, com.spvessel.spacevil.ResizableItem, com.spvessel.spacevil.HorizontalSlider, com.spvessel.spacevil.VerticalSlider, com.spvessel.spacevil.ComboBoxDropDown, com.spvessel.spacevil.ComboBox, com.spvessel.spacevil.WrapArea, com.spvessel.spacevil.ButtonToggle, com.spvessel.spacevil.ListArea, and com.spvessel.spacevil.TreeView.

◆ setConfines() [1/2]

void com.spvessel.spacevil.Core.InterfaceBaseItem.setConfines ( )

Setting the confines of the item relative to its parent's size and position.

Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user.

Implemented in com.spvessel.spacevil.BaseItem, com.spvessel.spacevil.Prototype, com.spvessel.spacevil.ComboBoxDropDown, com.spvessel.spacevil.ContextMenu, and com.spvessel.spacevil.FloatItem.

◆ setConfines() [2/2]

void com.spvessel.spacevil.Core.InterfaceBaseItem.setConfines	(	int	x0,
		int	x1,
		int	y0,
		int	y1
	)

Setting the confines of the item relative to specified bounds.

Example: items can be partially (or completely) outside the container (example: ListBox), in which case the part that is outside the container should not be visible and should not interact with the user.

Parameters

x0	Left X begin position.
x1	Right X end position.
y0	Top Y begin position.
y1	Bottom Y end position.

Implemented in com.spvessel.spacevil.BaseItem, and com.spvessel.spacevil.Prototype.

◆ setDrawable()

void com.spvessel.spacevil.Core.InterfaceBaseItem.setDrawable ( boolean value )

Setting the drawable (visibility) status of an item.

This property used in conjunction with the isVisible() property.

Explanation: an item can be visible and invisible, in some cases the item can be located outside the container (example: com.spvessel.spacevil.ListBox), and it must be invisible so as not to waste CPU / GPU resources, but in some cases you must control the visibility of elements that are inside container and should be invisible (example: com.spvessel.spacevil.TreeView).

Parameters

value True: if item should be drawable (visible). False: if item should not be drawable (invisible).

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ setHandler()

void com.spvessel.spacevil.Core.InterfaceBaseItem.setHandler ( CoreWindow handler )

Setting the window to which the item will belong.

Parameters

handler Window as com.spvessel.spacevil.CoreWindow.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ setMargin() [1/2]

void com.spvessel.spacevil.Core.InterfaceBaseItem.setMargin ( Indents margin )

Setting the indents of an item to offset itself relative to its container.

Parameters

margin Margin as com.spvessel.spacevil.Decorations.Indents.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ setMargin() [2/2]

void com.spvessel.spacevil.Core.InterfaceBaseItem.setMargin	(	int	left,
		int	top,
		int	right,
		int	bottom
	)

Setting the indents of an item to offset itself relative to its container.

Parameters

left	Indent on the left.
top	Indent on the top.
right	Indent on the right.
bottom	Indent on the bottom.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ setParent()

void com.spvessel.spacevil.Core.InterfaceBaseItem.setParent ( Prototype parent )

Setting the parent of the item.

Parameters

parent Parent as com.spvessel.spacevil.Prototype (Prototype is container and can contains children).

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ setShadow()

void com.spvessel.spacevil.Core.InterfaceBaseItem.setShadow	(	int	radius,
		int	x,
		int	y,
		Color	color
	)

Setting the shadow with specified blur radius, axis shifts, shadow color.

Parameters

radius	A blur radius of the shadow.
x	X shift of the shadow.
y	Y shift of the shadow.
color	A shadow color as java.awt.Color.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ setShadowColor()

void com.spvessel.spacevil.Core.InterfaceBaseItem.setShadowColor ( Color color )

Setting shadow color.

Parameters

color Shadow color as java.awt.Color.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ setShadowDrop()

void com.spvessel.spacevil.Core.InterfaceBaseItem.setShadowDrop ( boolean value )

Setting the shadow visibility status of an item.

Parameters

value True: if shadow should be visible. False: if shadow should be invisible.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ setShadowRadius()

void com.spvessel.spacevil.Core.InterfaceBaseItem.setShadowRadius ( int radius )

Setting the specified blur radius of the shadow.

Default: 0.

Parameters

radius The blur radius of the shadow.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

◆ setStyle()

void com.spvessel.spacevil.Core.InterfaceBaseItem.setStyle ( Style style )

Setting a style that describes the appearance of an item.

Parameters

style Style as com.spvessel.spacevil.Decorations.Style.

◆ setVisible()

void com.spvessel.spacevil.Core.InterfaceBaseItem.setVisible ( boolean value )

Setting the visibility status of an item.

This property may used in conjunction with the isDrawable() property.

Parameters

value True: if item should be visible. False: if item should be invisible.

Implemented in com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.BaseItem.

The documentation for this interface was generated from the following file:

InterfaceBaseItem.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ getCoreStyle()

◆ getHandler()

◆ getMargin()

◆ getParent()

◆ getShadowColor()

◆ getShadowExtension()

◆ getShadowPos()

◆ getShadowRadius()

◆ initElements()

◆ isDrawable()

◆ isShadowDrop()

◆ isVisible()

◆ release()

◆ setConfines() [1/2]

◆ setConfines() [2/2]

◆ setDrawable()

◆ setHandler()

◆ setMargin() [1/2]

◆ setMargin() [2/2]

◆ setParent()

◆ setShadow()

◆ setShadowColor()

◆ setShadowDrop()

◆ setShadowRadius()

◆ setStyle()

◆ setVisible()