SideArea is a container designed to show when it is needed, and the rest of the time SideArea is hidden. More...

Inherits com.spvessel.spacevil.Prototype, and com.spvessel.spacevil.Core.InterfaceFloating.

Public Member Functions
boolean	isOutsideClickClosable ()
	Returns True if SideArea (see com.spvessel.spacevil.InterfaceFloating) should closes when mouse click outside the area of SideArea otherwise returns False. More...

void	setOutsideClickClosable (boolean value)
	Setting boolean value of item's behavior when mouse click occurs outside the SideArea. More...

Side	getAttachSide ()
	Getting the side of the window which SideArea is attached. More...

void	setAttachSide (Side side)
	Setting the side of the window which SideArea will be attached. More...

int	getAreaSize ()
	Getting actual size of SideArea. More...

void	setAreaSize (int size)
	Setting actual size of SideArea. More...

	SideArea (CoreWindow handler, Side attachSide)
	Constructs SideArea with the specified side and the specified window for attachment. More...

void	initElements ()
	Initializing all elements in the SideArea. More...

void	addItem (InterfaceBaseItem item)
	Adding item to the SideArea. More...

void	insertItem (InterfaceBaseItem item, int index)
	Inserting item to the SideArea. More...

boolean	removeItem (InterfaceBaseItem item)
	Removing the specified item from SideArea. More...

void	setWidth (int width)
	Setting SideArea width. More...

void	setHeight (int height)
	Setting SideArea height. More...

void	show ()
	Shows the SideArea at the proper position. More...

void	show (InterfaceItem sender, MouseArgs args)
	Shows the SideArea at the proper position. More...

void	hide ()
	Hide the SideArea without destroying. More...

void	hide (MouseArgs args)
	Hide the SideArea without destroying with using specified mouse arguments. More...

void	setStyle (Style style)
	Setting style of the SideArea. More...

Public Member Functions inherited from com.spvessel.spacevil.Prototype
	Prototype ()
	Default constructor of Prototype class. More...

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

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

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

String	getToolTip ()
	Getting tooltip text of the item. More...

void	setToolTip (String text)
	Setting tooltip text of the item. More...

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

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

Spacing	getSpacing ()
	Getting indents between children of a container type item. More...

void	setSpacing (Spacing spacing)
	Setting indents between children of a container type item. More...

void	setSpacing (int horizontal, int vertical)
	Setting indents between children of a container type item. More...

Indents	getPadding ()
	Getting indents of an item for offset its children. More...

void	setPadding (Indents padding)
	Setting indents of an item to offset its children. More...

void	setPadding (int left, int top, int right, int bottom)
	Setting indents of an item to offset its children. More...

Indents	getMargin ()
	Getting the indents of an item to offset itself relative to its container. 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...

void	setBorder (Border border)
	Setting border of an item's shape. More...

void	setBorderFill (Color fill)
	Setting the border color of an item's shape. More...

Color	getBorderFill ()
	Getting the border color oa an item's shape. More...

void	setBorderFill (int r, int g, int b)
	Setting the border color of an item's shape in byte RGB format. More...

void	setBorderFill (int r, int g, int b, int a)
	Setting the border color of an item's shape in byte RGB format. More...

void	setBorderFill (float r, float g, float b)
	Setting the border color of an item's shape in float RGB format. More...

void	setBorderFill (float r, float g, float b, float a)
	Setting the border color of an item's shape in float RGBA format. More...

void	setBorderRadius (CornerRadius radius)
	Setting radius of the border's corners. More...

void	setBorderRadius (int radius)
	Setting border radius with the same values for each corner of the rectangle object. More...

CornerRadius	getBorderRadius ()
	Getting border radiuses. More...

void	setBorderThickness (int thickness)
	Setting border thickness of an item's shape. More...

int	getBorderThickness ()
	Getting border thickness of an item's shape. More...

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

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

void	makeShape ()
	Making default item's shape. More...

void	setBackground (Color color)
	Setting background color of an item's shape. More...

void	setBackground (int r, int g, int b)
	Setting background color of an item's shape in byte RGB format. More...

void	setBackground (int r, int g, int b, int a)
	Setting background color of an item in byte RGBA format. More...

void	setBackground (float r, float g, float b)
	Setting background color of an item in float RGB format. More...

void	setBackground (float r, float g, float b, float a)
	Setting background color of an item in float RGBA format. More...

Color	getBackground ()
	Getting background color of an item. More...

void	setItemName (String name)
	Setting the name of the item. More...

String	getItemName ()
	Getting the name of the item. More...

void	setMinWidth (int width)
	Setting the minimum width limit. More...

int	getMinWidth ()
	Getting the minimum width limit. More...

int	getWidth ()
	Getting item width. More...

void	setMaxWidth (int width)
	Setting the maximum width limit. More...

int	getMaxWidth ()
	Getting the maximum width limit. More...

void	setMinHeight (int height)
	Setting the minimum height limit. More...

int	getMinHeight ()
	Getting the minimum height limit. More...

int	getHeight ()
	Getting item height. More...

void	setMaxHeight (int height)
	Setting the maximum height limit. More...

int	getMaxHeight ()
	Getting the maximum height limit. More...

void	setSize (int width, int height)
	Setting item size (width and height). More...

Size	getSize ()
	Getting current item size. More...

void	setMinSize (int width, int height)
	Setting minimum item size limit (width and height limits). More...

Size	getMinSize ()
	Getting current item minimum size limit. More...

void	setMaxSize (int width, int height)
	Setting maximum item size limit (width and height limits). More...

Size	getMaxSize ()
	Getting current item maximum size limit. More...

void	setAlignment (List< ItemAlignment > alignment)
	Setting an alignment of an item's shape relative to its container. More...

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	setSizePolicy (SizePolicy width, SizePolicy height)
	Setting the size policy of an item's shape. 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...

void	setPosition (int x, int y)
	Setting item position. More...

void	setX (int x)
	Setting X coordinate of the left-top corner of a shape. More...

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

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

int	getY ()
	Getting Y coordinate of the left-top corner of a shape. 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 its parent's size and position. More...

Style	getCoreStyle ()
	Getting the core (only appearance properties without inner styles) style 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	setShadowExtension (int wExtension, int hExtension)
	Setting 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	addItemState (ItemStateType type, ItemState state)
	Adding visual state for an item. More...

void	removeItemState (ItemStateType type)
	Removing visual state of an item by type. More...

void	removeAllItemStates ()
	Removing all item visual states. More...

ItemState	getState (ItemStateType type)
	Getting item visual state by its type. More...

List< InterfaceBaseItem >	getItems ()
	Getting list of the Prototype's inner items (children). More...

void	clear ()
	Removing all children. More...

void	addItems (InterfaceBaseItem... items)
	Adding sequence of items into the container (this). More...

void	update (GeometryEventType type, int value)
	Updating an item size or/and position. 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 ()
	Setting the visibility status of an item. More...

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

boolean	isPassEvents ()
	Getting boolean value to know if this item can pass further any input events (mouse, keyboard and etc.). More...

boolean	isPassEvents (InputEventType e)
	Getting boolean value to know if this item can pass further the specified type of input events (mouse, keyboard and etc.). More...

List< InputEventType >	getPassEvents ()
	Getting all allowed input events. More...

List< InputEventType >	GetBlockedEvents ()
	Getting all blocked input events. More...

void	setPassEvents (boolean value)
	Setting on or off so that this item can pass further any input events (mouse, keyboard and etc.). More...

void	setPassEvents (boolean value, InputEventType e)
	Setting on or off so that this item can pass further the specified type of input events (mouse, keyboard and etc.). More...

void	setPassEvents (boolean value, List< InputEventType > events)
	Setting on or off so that this item can pass further the specified types of input events (mouse, keyboard and etc.). More...

void	setPassEvents (boolean value, InputEventType... events)
	Setting on or off so that this item can pass further the specified types of input events (mouse, keyboard and etc.). More...

boolean	isDisabled ()
	Returns True if this item is disabled (non-interactive) otherwise returns False. More...

void	setDisabled (boolean value)
	Setting this item disabled (become non-interactive) or enabled. More...

boolean	isMouseHover ()
	Returns True if this item is hovered otherwise returns False. More...

void	setMouseHover (boolean value)
	Setting this item hovered (mouse cursor located within item's shape). More...

boolean	isMousePressed ()
	Returns True if mouse is pressed on this item (mouse cursor located within item's shape and any of the mouse button is pressed) otherwise False. More...

void	setMousePressed (boolean value)
	Setting True if you want that mouse is pressed on this item (mouse cursor located within item's shape and any of the mouse button is pressed) otherwise False. More...

boolean	isFocused ()
	Returns True if this item gets focus otherwise False. More...

void	setFocus ()
	Setting focus on this item if it is focusable. More...

void	setContent (List< InterfaceBaseItem > content)
	Setting content for this item. More...

Figure	isCustomFigure ()
	Getting the custom shape if it is set. More...

void	setCustomFigure (Figure figure)
	Setting the custom shape to replace the default rectangle shape. More...

ItemHoverRule	getHoverRule ()
	Getting the hovering rule of this item. More...

void	setHoverRule (ItemHoverRule rule)
	Setting the hovering rule for this item. More...

CursorImage	getCursor ()
	Getting the mouse cursor image of this item. More...

void	setCursor (EmbeddedCursor cursor)
	Setting mouse cursor image for this item from embedded cursors. More...

void	setCursor (CursorImage cursor)
	Setting mouse cursor image for this item. More...

void	setCursor (BufferedImage bitmap)
	Creating and setting mouse cursor image for this item from specified bitmap image. More...

void	setCursor (BufferedImage bitmap, int width, int height)
	Creating and setting mouse cursor image for this item from specified scaled bitmap image. More...

Public Attributes
ResizableItem	window
	Resizable container area of SideArea. More...

Public Attributes inherited from com.spvessel.spacevil.Prototype
EventCommonMethodState	eventResize = new EventCommonMethodState()
	Event that is invoked when an item is resizing. More...

EventCommonMethodState	eventDestroy = new EventCommonMethodState()
	Event that is invoked when an item is destroyed (removed). More...

EventMouseMethodState	eventMouseHover = new EventMouseMethodState()
	Event that is invoked when mouse cursor enters inside an item area. More...

EventMouseMethodState	eventMouseLeave = new EventMouseMethodState()
	Event that is invoked when mouse cursor leaves inside an item area. More...

EventMouseMethodState	eventMouseClick = new EventMouseMethodState()
	Event that is invoked when mouse click (release) on an item. More...

EventMouseMethodState	eventMouseDoubleClick = new EventMouseMethodState()
	Event that is invoked when mouse double click on an item. More...

EventMouseMethodState	eventMousePress = new EventMouseMethodState()
	Event that is invoked when mouse press on an item. More...

EventMouseMethodState	eventMouseDrag = new EventMouseMethodState()
	Event that is invoked when mouse drag on an item. More...

EventMouseMethodState	eventMouseDrop = new EventMouseMethodState()
	Event that is invoked when mouse drop on an item. More...

EventMouseMethodState	eventScrollUp = new EventMouseMethodState()
	Event that is invoked when mouse wheel scrolls up on an item. More...

EventMouseMethodState	eventScrollDown = new EventMouseMethodState()
	Event that is invoked when mouse wheel scrolls down on an item. More...

EventKeyMethodState	eventKeyPress = new EventKeyMethodState()
	Event that is invoked when key of keyboard is pressed. More...

EventKeyMethodState	eventKeyRelease = new EventKeyMethodState()
	Event that is invoked when key of keyboard is released. More...

EventInputTextMethodState	eventTextInput = new EventInputTextMethodState()
	Event that is invoked when typing text on the keyboard. More...

boolean	isFocusable = true
	Item's focusable property. More...

Additional Inherited Members
Protected Member Functions inherited from com.spvessel.spacevil.Prototype
void	updateState ()
	Updating Prototype's state according to its ItemStateType. More...

void	setFocused (boolean value)

boolean	getHoverVerification (float xpos, float ypos)

int[]	getConfines ()

void	setState (ItemStateType state)

Detailed Description

SideArea is a container designed to show when it is needed, and the rest of the time SideArea is hidden.

SideArea is a floating item (see com.spvessel.spacevil.InterfaceFloating and enum com.spvessel.spacevil.Flags.LayoutType) Always attached to one of the four sides of window.

Contains close button and resizable area.

Supports all events except drag and drop.

Notice: All floating items render above all others items.

SideArea does not pass any input events and invisible by default.

Constructor & Destructor Documentation

◆ SideArea()

com.spvessel.spacevil.SideArea.SideArea	(	CoreWindow	handler,
		Side	attachSide
	)

Constructs SideArea with the specified side and the specified window for attachment.

(see com.spvessel.spacevil.CoreWindow, com.spvessel.spacevil.ActiveWindow, com.spvessel.spacevil.DialogWindow).

SideArea does not pass any input events and invisible by default.

Parameters

handler	Window for attaching SideArea.
attachSide	Side of the window as com.spvessel.spacevil.Flags.Side.

Member Function Documentation

◆ addItem()

void com.spvessel.spacevil.SideArea.addItem ( InterfaceBaseItem item )

Adding item to the SideArea.

Parameters

item	Item as com.spvessel.spacevil.Core.InterfaceBaseItem.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ getAreaSize()

int com.spvessel.spacevil.SideArea.getAreaSize ( )

Getting actual size of SideArea.

If SideArea is attached to Side.LEFT or Side.RIGHT, then this value is the width of the area, otherwise, the height.

Default: 300.

Returns: Actual size of SideArea.

◆ getAttachSide()

Side com.spvessel.spacevil.SideArea.getAttachSide ( )

Getting the side of the window which SideArea is attached.

Default: Side.LEFT.

Returns: Side of the window as com.spvessel.spacevil.Flags.Side.

◆ hide() [1/2]

void com.spvessel.spacevil.SideArea.hide ( )

Hide the SideArea without destroying.

Implements com.spvessel.spacevil.Core.InterfaceFloating.

◆ hide() [2/2]

void com.spvessel.spacevil.SideArea.hide ( MouseArgs args )

Hide the SideArea without destroying with using specified mouse arguments.

This method do exactly as hide() method without arguments.

Parameters

args	Arguments as com.spvessel.spacevil.Core.MouseArgs.

Implements com.spvessel.spacevil.Core.InterfaceFloating.

◆ initElements()

void com.spvessel.spacevil.SideArea.initElements ( )

Initializing all elements in the SideArea.

Notice: This method is mainly for overriding only. SpaceVIL calls this method if necessary and no need to call it manually.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ insertItem()

void com.spvessel.spacevil.SideArea.insertItem	(	InterfaceBaseItem	item,
		int	index
	)

Inserting item to the SideArea.

Parameters

item	Item as com.spvessel.spacevil.Core.InterfaceBaseItem.
index	Index of insertion.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ isOutsideClickClosable()

boolean com.spvessel.spacevil.SideArea.isOutsideClickClosable ( )

Returns True if SideArea (see com.spvessel.spacevil.InterfaceFloating) should closes when mouse click outside the area of SideArea otherwise returns False.

Returns: True: if SideArea closes when mouse click outside the area. False: if SideArea stays opened when mouse click outside the area.

Implements com.spvessel.spacevil.Core.InterfaceFloating.

◆ removeItem()

boolean com.spvessel.spacevil.SideArea.removeItem ( InterfaceBaseItem item )

Removing the specified item from SideArea.

Parameters

item	Item as com.spvessel.spacevil.Core.InterfaceBaseItem.

Returns: True: if the removal was successful. False: if the removal was unsuccessful.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setAreaSize()

void com.spvessel.spacevil.SideArea.setAreaSize ( int size )

Setting actual size of SideArea.

If SideArea is attached to Side.LEFT or Side.RIGHT, then this value is the width of the area, otherwise, the height.

Default: 300.

Parameters

size	Actual size of SideArea.

◆ setAttachSide()

void com.spvessel.spacevil.SideArea.setAttachSide ( Side side )

Setting the side of the window which SideArea will be attached.

Default: Side.LEFT.

Parameters

side	Side of the window as com.spvessel.spacevil.Flags.Side.

◆ setHeight()

void com.spvessel.spacevil.SideArea.setHeight ( int height )

Setting SideArea height.

If the value is greater/less than the maximum/minimum value of the height, then the height becomes equal to the maximum/minimum value.

Parameters

height Height of the SideArea.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setOutsideClickClosable()

void com.spvessel.spacevil.SideArea.setOutsideClickClosable ( boolean value )

Setting boolean value of item's behavior when mouse click occurs outside the SideArea.

Parameters

value True: SideArea should become invisible if mouse click occurs outside the item. False: an item should stay visible if mouse click occurs outside the item.

Implements com.spvessel.spacevil.Core.InterfaceFloating.

◆ setStyle()

void com.spvessel.spacevil.SideArea.setStyle ( Style style )

Setting style of the SideArea.

Inner styles: "window", "closebutton".

Parameters

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

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setWidth()

void com.spvessel.spacevil.SideArea.setWidth ( int width )

Setting SideArea width.

If the value is greater/less than the maximum/minimum value of the width, then the width becomes equal to the maximum/minimum value.

Parameters

width Width of the SideArea.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ show() [1/2]

void com.spvessel.spacevil.SideArea.show ( )

Shows the SideArea at the proper position.

Implements com.spvessel.spacevil.Core.InterfaceFloating.

◆ show() [2/2]

void com.spvessel.spacevil.SideArea.show	(	InterfaceItem	sender,
		MouseArgs	args
	)

Shows the SideArea at the proper position.

This method do exactly as show() method without arguments.

Parameters

sender	The item from which the show request is sent.
args	Mouse click arguments (cursor position, mouse button, mouse button press/release, etc.).

Implements com.spvessel.spacevil.Core.InterfaceFloating.

Member Data Documentation

◆ window

ResizableItem com.spvessel.spacevil.SideArea.window

Resizable container area of SideArea.

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

SideArea.java

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SideArea()

Member Function Documentation

◆ addItem()

◆ getAreaSize()

◆ getAttachSide()

◆ hide() [1/2]

◆ hide() [2/2]

◆ initElements()

◆ insertItem()

◆ isOutsideClickClosable()

◆ removeItem()

◆ setAreaSize()

◆ setAttachSide()

◆ setHeight()

◆ setOutsideClickClosable()

◆ setStyle()

◆ setWidth()

◆ show() [1/2]

◆ show() [2/2]

Member Data Documentation

◆ window