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.
|
WrapGrid is a container and manager of com.spvessel.spacevil.WrapArea (scrollable container for other elements with ability of selection, groups elements in cells of a certain size) and scroll bars. More...
Inherits com.spvessel.spacevil.Prototype.
Public Member Functions | |
boolean | isStretch () |
Returns True if internal com.spvessel.spacevil.WrapArea allocates all available space between cells to achieve smooth streching, otherwise returns False. More... | |
void | setStretch (boolean value) |
Setting strech mode for internal com.spvessel.spacevil.WrapArea. More... | |
int | getRowCount () |
Getting current row count. More... | |
int | getColumnCount () |
Getting current column count. More... | |
int | getCellWidth () |
Getting current cell width. More... | |
int | getCellHeight () |
Getting current cell height. More... | |
void | setCellWidth (int cellWidth) |
Setting cell width. More... | |
void | setCellHeight (int cellHeight) |
Setting cell height. More... | |
void | setCellSize (int cellWidth, int cellHeight) |
Setting cell size. More... | |
void | setScrollStep (int value) |
Setting scroll movement step. More... | |
int | getScrollStep () |
Getting scroll movement step. More... | |
int | getSelection () |
Getting index of selected item. More... | |
void | setSelection (int index) |
Select item by index. More... | |
void | unselect () |
Unselect selected item. More... | |
void | setSelectionVisible (boolean value) |
Enable or disable selection ability of com.spvessel.spacevil.WrapArea. More... | |
boolean | isSelectionVisible () |
Returns True if selection ability of com.spvessel.spacevil.WrapArea is enabled otherwise returns False. More... | |
WrapArea | getArea () |
Getting list area of WrapGrid. More... | |
Orientation | getOrientation () |
Getting internal com.spvessel.spacevil.WrapArea orientation. More... | |
VisibilityPolicy | getScrollBarPolicy () |
Getting scroll bar visibility policy. More... | |
void | setScrollBarPolicy (VisibilityPolicy policy) |
Setting scroll bar visibility policy. More... | |
WrapGrid (int cellWidth, int cellHeight, Orientation orientation) | |
Constructs a WrapGrid with specified cell width, height and orientation. More... | |
void | setWidth (int width) |
Setting item width. More... | |
void | setHeight (int height) |
Setting item height. More... | |
void | addItem (InterfaceBaseItem item) |
Adding item to the list area of WrapGrid. More... | |
void | insertItem (InterfaceBaseItem item, int index) |
Insert item into the list area of WrapGrid by index. More... | |
boolean | removeItem (InterfaceBaseItem item) |
Removing the specified item from the list area of WrapGrid. More... | |
void | clear () |
Removing all items from the list area of WrapGrid. More... | |
void | initElements () |
Initializing all elements in the WrapGrid. More... | |
List< InterfaceBaseItem > | getListContent () |
Getting content of the list area of WrapGrid. More... | |
void | setListContent (List< InterfaceBaseItem > content) |
Adding all elements in the list area of WrapGrid from the given list. More... | |
InterfaceBaseItem | getWrapper (InterfaceBaseItem item) |
Getting wrapper of item. More... | |
InterfaceBaseItem | getSelectedItem () |
Getting selected item. More... | |
void | setStyle (Style style) |
Setting style of the CheckBox. 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 | 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 | |
VerticalScrollBar | vScrollBar |
Vertical scroll bar of WrapGrid. More... | |
HorizontalScrollBar | hScrollBar |
Horizontal scroll bar of WrapGrid. 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) |
WrapGrid is a container and manager of com.spvessel.spacevil.WrapArea (scrollable container for other elements with ability of selection, groups elements in cells of a certain size) and scroll bars.
WrapGrid controls scrolling, resizing and other actions of com.spvessel.spacevil.WrapArea.
Contains list area, scroll bars, scroll menu.
Supports all events except drag and drop.
com.spvessel.spacevil.WrapGrid.WrapGrid | ( | int | cellWidth, |
int | cellHeight, | ||
Orientation | orientation | ||
) |
Constructs a WrapGrid with specified cell width, height and orientation.
cellWidth | Width of each cell. |
cellHeight | Height of each cell. |
orientation | Orientation of layout as com.spvessel.spacevil.Flags.Orientation. |
void com.spvessel.spacevil.WrapGrid.addItem | ( | InterfaceBaseItem | item | ) |
Adding item to the list area of WrapGrid.
item | Item as com.spvessel.spacevil.Core.InterfaceBaseItem. |
Reimplemented from com.spvessel.spacevil.Prototype.
void com.spvessel.spacevil.WrapGrid.clear | ( | ) |
Removing all items from the list area of WrapGrid.
Reimplemented from com.spvessel.spacevil.Prototype.
WrapArea com.spvessel.spacevil.WrapGrid.getArea | ( | ) |
Getting list area of WrapGrid.
int com.spvessel.spacevil.WrapGrid.getCellHeight | ( | ) |
Getting current cell height.
int com.spvessel.spacevil.WrapGrid.getCellWidth | ( | ) |
Getting current cell width.
int com.spvessel.spacevil.WrapGrid.getColumnCount | ( | ) |
Getting current column count.
List<InterfaceBaseItem> com.spvessel.spacevil.WrapGrid.getListContent | ( | ) |
Getting content of the list area of WrapGrid.
Orientation com.spvessel.spacevil.WrapGrid.getOrientation | ( | ) |
Getting internal com.spvessel.spacevil.WrapArea orientation.
Orientation can be Orientation.HORIZONTAL or Orientation.VERTICAL.
int com.spvessel.spacevil.WrapGrid.getRowCount | ( | ) |
Getting current row count.
VisibilityPolicy com.spvessel.spacevil.WrapGrid.getScrollBarPolicy | ( | ) |
Getting scroll bar visibility policy.
int com.spvessel.spacevil.WrapGrid.getScrollStep | ( | ) |
Getting scroll movement step.
InterfaceBaseItem com.spvessel.spacevil.WrapGrid.getSelectedItem | ( | ) |
Getting selected item.
int com.spvessel.spacevil.WrapGrid.getSelection | ( | ) |
Getting index of selected item.
InterfaceBaseItem com.spvessel.spacevil.WrapGrid.getWrapper | ( | InterfaceBaseItem | item | ) |
Getting wrapper of item.
item | Item as com.spvessel.spacevil.Core.InterfaceBaseItem. |
void com.spvessel.spacevil.WrapGrid.initElements | ( | ) |
Initializing all elements in the WrapGrid.
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.
void com.spvessel.spacevil.WrapGrid.insertItem | ( | InterfaceBaseItem | item, |
int | index | ||
) |
Insert item into the list area of WrapGrid by index.
item | Child as com.spvessel.spacevil.Core.InterfaceBaseItem. |
index | Index of insertion. |
Reimplemented from com.spvessel.spacevil.Prototype.
boolean com.spvessel.spacevil.WrapGrid.isSelectionVisible | ( | ) |
Returns True if selection ability of com.spvessel.spacevil.WrapArea is enabled otherwise returns False.
boolean com.spvessel.spacevil.WrapGrid.isStretch | ( | ) |
Returns True if internal com.spvessel.spacevil.WrapArea allocates all available space between cells to achieve smooth streching, otherwise returns False.
boolean com.spvessel.spacevil.WrapGrid.removeItem | ( | InterfaceBaseItem | item | ) |
Removing the specified item from the list area of WrapGrid.
item | Item as com.spvessel.spacevil.Core.InterfaceBaseItem. |
Reimplemented from com.spvessel.spacevil.Prototype.
void com.spvessel.spacevil.WrapGrid.setCellHeight | ( | int | cellHeight | ) |
Setting cell height.
cellHeight | Cell height. |
void com.spvessel.spacevil.WrapGrid.setCellSize | ( | int | cellWidth, |
int | cellHeight | ||
) |
void com.spvessel.spacevil.WrapGrid.setCellWidth | ( | int | cellWidth | ) |
Setting cell width.
cellWidth | Cell width. |
void com.spvessel.spacevil.WrapGrid.setHeight | ( | int | height | ) |
Setting item 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.
height | Height of the item. |
Reimplemented from com.spvessel.spacevil.Prototype.
void com.spvessel.spacevil.WrapGrid.setListContent | ( | List< InterfaceBaseItem > | content | ) |
Adding all elements in the list area of WrapGrid from the given list.
content | List of items as List<com.spvessel.spacevil.Core.InterfaceBaseItem> |
void com.spvessel.spacevil.WrapGrid.setScrollBarPolicy | ( | VisibilityPolicy | policy | ) |
Setting scroll bar visibility policy.
Default: com.spvessel.spacevil.Flags.VisibilityPolicy.AS_NEEDED.
policy | Visibility policy as com.spvessel.spacevil.Flags.VisibilityPolicy. |
void com.spvessel.spacevil.WrapGrid.setScrollStep | ( | int | value | ) |
Setting scroll movement step.
value | Scroll step. |
void com.spvessel.spacevil.WrapGrid.setSelection | ( | int | index | ) |
Select item by index.
index | Index of selection. |
void com.spvessel.spacevil.WrapGrid.setSelectionVisible | ( | boolean | value | ) |
Enable or disable selection ability of com.spvessel.spacevil.WrapArea.
value | True: if you want selection ability of com.spvessel.spacevil.WrapArea to be enabled. False: if you want selection ability of com.spvessel.spacevil.WrapArea to be disabled. |
void com.spvessel.spacevil.WrapGrid.setStretch | ( | boolean | value | ) |
Setting strech mode for internal com.spvessel.spacevil.WrapArea.
com.spvessel.spacevil.WrapArea can allocates all available space between cells or uses fixed space between cells.
value | True: if you want to com.spvessel.spacevil.WrapArea allocates all available space between cells. False: if you want space between cells to be fixed. |
void com.spvessel.spacevil.WrapGrid.setStyle | ( | Style | style | ) |
Setting style of the CheckBox.
Inner styles: "area", "vscrollbar", "hscrollbar".
style | Style as com.spvessel.spacevil.Decorations.Style. |
Reimplemented from com.spvessel.spacevil.Prototype.
void com.spvessel.spacevil.WrapGrid.setWidth | ( | int | width | ) |
Setting item 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.
width | Width of the item. |
Reimplemented from com.spvessel.spacevil.Prototype.
void com.spvessel.spacevil.WrapGrid.unselect | ( | ) |
Unselect selected item.
HorizontalScrollBar com.spvessel.spacevil.WrapGrid.hScrollBar |
Horizontal scroll bar of WrapGrid.
VerticalScrollBar com.spvessel.spacevil.WrapGrid.vScrollBar |
Vertical scroll bar of WrapGrid.