Reference for JVM version of SpaceVIL  0.3.5.8
SpaceVIL (Space of Visual Items Layout) is a cross-platform and multilingual framework for creating GUI client applications for .NET Standard, .NET Core and JVM. SpaceVIL is based on OpenGL graphic technology and GLFW. Using this framework in conjunction with .Net Core or with a JVM, you can work and create graphical client applications on Linux, Mac OS X and Windows.
com.spvessel.spacevil.Grid Class Reference

Grid is a class that represents a grid type container. More...

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

Public Member Functions

 Grid (int rows, int columns)
 Constructs a Grid with the given number of rows and number of columns. More...
 
void setFormat (int rows, int columns)
 Setting a new grid format with the given number of rows and number of columns. More...
 
void setRowCount (int value)
 Setting a new count of the rows. More...
 
int getRowCount ()
 Getting current rows count in grid. More...
 
void setColumnCount (int value)
 Setting a new count of the columns. More...
 
int getColumnCount ()
 Getting current columns count in grid. More...
 
Cell getCell (int row, int column)
 Returns the cell by row and column number. More...
 
List< CellgetAllCells ()
 Getting all cells as list. More...
 
boolean removeItem (InterfaceBaseItem item)
 Removing item from the Grid. More...
 
boolean removeItem (int row, int column)
 Removing item from the Grid by number of row and number of column. More...
 
void clear ()
 Remove all items in the Grid. More...
 
void addItem (InterfaceBaseItem item)
 Adding item to the Grid. More...
 
void insertItem (InterfaceBaseItem item, int row, int column)
 Inserting item into the Cell by row and column index. More...
 
void insertItem (InterfaceBaseItem item, int index)
 Inserting item into the Cell by cell index. More...
 
void setWidth (int width)
 Setting Grid width. More...
 
void setX (int x)
 Setting X coordinate of the left-top corner of the Grid. More...
 
void setHeight (int height)
 Setting Grid height. More...
 
void setY (int y)
 Setting Y coordinate of the left-top corner of the Grid. More...
 
void updateLayout ()
 Updating all children positions (implementation of com.spvessel.spacevil.Core.InterfaceFreeLayout). 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...
 
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...
 
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< ItemAlignmentgetAlignment ()
 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< InterfaceBaseItemgetItems ()
 Getting list of the Prototype's inner items (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< InputEventTypegetPassEvents ()
 Getting all allowed input events. More...
 
List< InputEventTypeGetBlockedEvents ()
 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...
 

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)
 

Additional Inherited Members

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

Detailed Description

Grid is a class that represents a grid type container.

Each element is in a specific grid cell.

Cells size based on items margins, sizes and size policies.

Grid cannot receive any events, so Grid is always in the com.spvessel.spacevil.Flags.ItemStateType.BASE state.

Constructor & Destructor Documentation

◆ Grid()

com.spvessel.spacevil.Grid.Grid ( int  rows,
int  columns 
)

Constructs a Grid with the given number of rows and number of columns.

Parameters
rowsNumber of rows.
columnsNumber of columns.

Member Function Documentation

◆ addItem()

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

Adding item to the Grid.

Parameters
itemItem as com.spvessel.spacevil.Core.InterfaceBaseItem.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ clear()

void com.spvessel.spacevil.Grid.clear ( )

Remove all items in the Grid.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ getAllCells()

List<Cell> com.spvessel.spacevil.Grid.getAllCells ( )

Getting all cells as list.

Returns
Cells as List<com.spvessel.spacevil.Cell>

◆ getCell()

Cell com.spvessel.spacevil.Grid.getCell ( int  row,
int  column 
)

Returns the cell by row and column number.

Parameters
rowNumber of cell row.
columnNumber of cell column.
Returns
Cell of the Grid as com.spvessel.spacevil.Cell.

◆ getColumnCount()

int com.spvessel.spacevil.Grid.getColumnCount ( )

Getting current columns count in grid.

Returns
Current columns count.

◆ getHoverVerification()

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

Reimplemented from com.spvessel.spacevil.Prototype.

◆ getRowCount()

int com.spvessel.spacevil.Grid.getRowCount ( )

Getting current rows count in grid.

Returns
Current rows count.

◆ insertItem() [1/2]

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

Inserting item into the Cell by cell index.

Parameters
itemItem as com.spvessel.spacevil.Core.InterfaceBaseItem.
indexCell index.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ insertItem() [2/2]

void com.spvessel.spacevil.Grid.insertItem ( InterfaceBaseItem  item,
int  row,
int  column 
)

Inserting item into the Cell by row and column index.

Parameters
itemItem as com.spvessel.spacevil.Core.InterfaceBaseItem.
rowRow index.
columnColumn index.

◆ removeItem() [1/2]

boolean com.spvessel.spacevil.Grid.removeItem ( int  row,
int  column 
)

Removing item from the Grid by number of row and number of column.

if the removal was successful Cell becomes free.

Parameters
rowIndex of row.
columnIndex of column.
Returns
True: if the removal was successful. False: if the removal was unsuccessful.

◆ removeItem() [2/2]

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

Removing item from the Grid.

if the removal was successful Cell becomes free.

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

◆ setColumnCount()

void com.spvessel.spacevil.Grid.setColumnCount ( int  value)

Setting a new count of the columns.

Parameters
valueNumber of columns.

◆ setFormat()

void com.spvessel.spacevil.Grid.setFormat ( int  rows,
int  columns 
)

Setting a new grid format with the given number of rows and number of columns.

Parameters
rowsNumber of rows.
columnsNumber of columns.

◆ setHeight()

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

Setting Grid 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
heightHeight of the Grid.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setRowCount()

void com.spvessel.spacevil.Grid.setRowCount ( int  value)

Setting a new count of the rows.

Parameters
valueNumber of rows.

◆ setWidth()

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

Setting Grid 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
widthWidth of the Grid.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setX()

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

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

Parameters
xX position of the left-top corner.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ setY()

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

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

Parameters
yY position of the left-top corner.

Reimplemented from com.spvessel.spacevil.Prototype.

◆ updateLayout()

void com.spvessel.spacevil.Grid.updateLayout ( )

Updating all children positions (implementation of com.spvessel.spacevil.Core.InterfaceFreeLayout).

Implements com.spvessel.spacevil.Core.InterfaceFreeLayout.


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