ImageItem is class for rendering loaded images. More...

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

Public Member Functions
Area	getAreaBounds ()
	Getting bounds for an image (for example: to keep aspect ratio). More...

BufferedImage	getImage ()
	Getting a bitmap image in the form as java.awt.image.BufferedImage. More...

void	setRotationAngle (float angle)
	Setting rotation angle for image. More...

float	getRotationAngle ()
	Getting rotation angle for image. More...

	ImageItem ()
	Default ImageItem constructor. More...

	ImageItem (BufferedImage picture)
	Constructs an ImageItem with an bitmap image. More...

	ImageItem (BufferedImage picture, boolean hover)
	Constructs an ImageItem with an bitmap image with the ability to enable or disable mouse events. More...

int	getImageWidth ()
	Getting an image width. More...

int	getImageHeight ()
	Getting an image height. More...

void	setImage (BufferedImage image)
	Setting new bitmap image of ImageItem. More...

Color	getColorOverlay ()
	Getting color overlay (useful in images that have alpha channel). More...

void	setColorOverlay (Color color)
	Setting color overlay (useful in images that have alpha channel). More...

void	setColorOverlay (Color color, boolean overlay)
	Setting color overlay (useful in images that have alpha channel) with ability to specify overlay status. More...

void	setColorOverlay (boolean overlay)
	Setting color overlay status. More...

boolean	isColorOverlay ()
	Getting color overlay status. More...

void	keepAspectRatio (boolean value)
	Setting value to keep or not to keep еру aspect ratio of the image. More...

boolean	isAspectRatio ()
	Returns True if aspect ratio of the image is kept otherwise returns False. More...

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

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

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

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

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

void	release ()
	Disposing bitmap resources if the item was removed. More...

Public Member Functions inherited from com.spvessel.spacevil.Prototype
	Prototype ()
	Default constructor of Prototype class. 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...

void	initElements ()
	Initializing children and their attributes. 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...

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...

int	getX ()
	Getting X 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...

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	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...

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

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

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

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

void	addItem (InterfaceBaseItem item)
	Adding item 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
boolean	isHover = false
	Property to enable or disable mouse events (hover, click, press, scroll). 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...

Protected Member Functions
boolean	getHoverVerification (float xpos, float ypos)

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

void	setFocused (boolean value)

int[]	getConfines ()

void	setState (ItemStateType state)

Detailed Description

ImageItem is class for rendering loaded images.

Supports all events except drag and drop.

Constructor & Destructor Documentation

◆ ImageItem() [1/3]

com.spvessel.spacevil.ImageItem.ImageItem ( )

Default ImageItem constructor.

Does not contains any image.

◆ ImageItem() [2/3]

com.spvessel.spacevil.ImageItem.ImageItem ( BufferedImage picture )

Constructs an ImageItem with an bitmap image.

Parameters

picture Bitmap image as java.awt.image.BufferedImage.

◆ ImageItem() [3/3]

com.spvessel.spacevil.ImageItem.ImageItem	(	BufferedImage	picture,
		boolean	hover
	)

Constructs an ImageItem with an bitmap image with the ability to enable or disable mouse events.

Parameters

picture	Bitmap image as java.awt.image.BufferedImage.
hover	True: ImageItem can receive mouse events. False: cannot receive mouse events.

Member Function Documentation

◆ getAreaBounds()

Area com.spvessel.spacevil.ImageItem.getAreaBounds ( )

Getting bounds for an image (for example: to keep aspect ratio).

Returns: Bounds as com.spvessel.spacevil.Core.Area.

Implements com.spvessel.spacevil.Core.InterfaceImageItem.

◆ getColorOverlay()

Color com.spvessel.spacevil.ImageItem.getColorOverlay ( )

Getting color overlay (useful in images that have alpha channel).

Returns: Color overlay as java.awt.Color.

Implements com.spvessel.spacevil.Core.InterfaceImageItem.

◆ getHoverVerification()

boolean com.spvessel.spacevil.ImageItem.getHoverVerification	(	float	xpos,
		float	ypos
	)

protected

Reimplemented from com.spvessel.spacevil.Prototype.

◆ getImage()

BufferedImage com.spvessel.spacevil.ImageItem.getImage ( )

Getting a bitmap image in the form as java.awt.image.BufferedImage.

Returns: Image as java.awt.image.BufferedImage.

Implements com.spvessel.spacevil.Core.InterfaceImageItem.

◆ getImageHeight()

int com.spvessel.spacevil.ImageItem.getImageHeight ( )

Getting an image height.

Returns: Image height.

Implements com.spvessel.spacevil.Core.InterfaceImageItem.

◆ getImageWidth()

int com.spvessel.spacevil.ImageItem.getImageWidth ( )

Getting an image width.

Returns: Image width.

Implements com.spvessel.spacevil.Core.InterfaceImageItem.

◆ getRotationAngle()

float com.spvessel.spacevil.ImageItem.getRotationAngle ( )

Getting rotation angle for image.

Returns: Rotation angle.

Implements com.spvessel.spacevil.Core.InterfaceImageItem.

◆ isAspectRatio()

boolean com.spvessel.spacevil.ImageItem.isAspectRatio ( )

Returns True if aspect ratio of the image is kept otherwise returns False.

Returns: True: if aspect ratio of the image is kept. False: if aspect ratio of the image is not kept.

◆ isColorOverlay()

boolean com.spvessel.spacevil.ImageItem.isColorOverlay ( )

Getting color overlay status.

Returns: True: if color overlay is using. False: if color overlay is not using.

Implements com.spvessel.spacevil.Core.InterfaceImageItem.

◆ keepAspectRatio()

void com.spvessel.spacevil.ImageItem.keepAspectRatio ( boolean value )

Setting value to keep or not to keep еру aspect ratio of the image.

Parameters

value True: to keep aspect ratio of the image. False: to not keep aspect ratio of the image.

◆ release()

void com.spvessel.spacevil.ImageItem.release ( )

Disposing bitmap resources if the item was removed.

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.

◆ setColorOverlay() [1/3]

void com.spvessel.spacevil.ImageItem.setColorOverlay ( boolean overlay )

Setting color overlay status.

Parameters

overlay True: if color overlay is using. False: if color overlay is not using.

◆ setColorOverlay() [2/3]

void com.spvessel.spacevil.ImageItem.setColorOverlay ( Color color )

Setting color overlay (useful in images that have alpha channel).

Parameters

color Color overlay as java.awt.Color.

◆ setColorOverlay() [3/3]

void com.spvessel.spacevil.ImageItem.setColorOverlay	(	Color	color,
		boolean	overlay
	)

Setting color overlay (useful in images that have alpha channel) with ability to specify overlay status.

Parameters

color	Color overlay as java.awt.Color.
overlay	True: if color overlay is using. False: if color overlay is not using.

◆ setHeight()

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

Setting ImageItem 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 ImageItem.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setImage()

void com.spvessel.spacevil.ImageItem.setImage ( BufferedImage image )

Setting new bitmap image of ImageItem.

Parameters

image New bitmap image as java.awt.image.BufferedImage.

◆ setRotationAngle()

void com.spvessel.spacevil.ImageItem.setRotationAngle ( float angle )

Setting rotation angle for image.

Default: 0.

Parameters

angle Rotation angle.

◆ setSize()

void com.spvessel.spacevil.ImageItem.setSize	(	int	width,
		int	height
	)

Setting ImageItem size (width and height).

Parameters

width	Width of the ImageItem.
height	Height of the ImageItem.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setWidth()

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

Setting ImageItem 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 ImageItem.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setX()

void com.spvessel.spacevil.ImageItem.setX ( int x )

Setting X coordinate of the left-top corner of the ImageItem.

Parameters

x	X position of the left-top corner.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setY()

void com.spvessel.spacevil.ImageItem.setY ( int y )

Setting Y coordinate of the left-top corner of the ImageItem.

Parameters

y	Y position of the left-top corner.

Reimplemented from com.spvessel.spacevil.Prototype.

Member Data Documentation

◆ isHover

boolean com.spvessel.spacevil.ImageItem.isHover = false

Property to enable or disable mouse events (hover, click, press, scroll).

True: ImageItem can receive mouse events. False: cannot receive mouse events.

Default: False.

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

ImageItem.java

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ImageItem() [1/3]

◆ ImageItem() [2/3]

◆ ImageItem() [3/3]

Member Function Documentation

◆ getAreaBounds()

◆ getColorOverlay()

◆ getHoverVerification()

◆ getImage()

◆ getImageHeight()

◆ getImageWidth()

◆ getRotationAngle()

◆ isAspectRatio()

◆ isColorOverlay()

◆ keepAspectRatio()

◆ release()

◆ setColorOverlay() [1/3]

◆ setColorOverlay() [2/3]

◆ setColorOverlay() [3/3]

◆ setHeight()

◆ setImage()

◆ setRotationAngle()

◆ setSize()

◆ setWidth()

◆ setX()

◆ setY()

Member Data Documentation

◆ isHover