Skip to content
This repository has been archived by the owner on May 27, 2021. It is now read-only.

Latest commit

 

History

History

lml-vis

README.md

VisUI parser for LML templates

See gdx-lml. This extension allows LML to create improved VisUI widgets instead of regular Scene2D actors.

Examples

Check gdx-lml-vis-tests for examples of all tags and macros usage. Check gdx-lml-vis-websocket for a simple (yet practical) mock-up application. gdx-lml-serialization-tests is a tiny application that uses gdx-lml-vis to create GUI. You can find a step-by-step tutorial how to include this library to create a simple application here.

See on-line demo here. See application mock-up here.

Dependencies

gdx-lml-vis is available through the official project creator tool: gdx-setup (in third party extensions). However, its version might not be up to date.

Gradle:

        compile "com.github.czyzby:gdx-lml-vis:$libVersion.$gdxVersion"

$libVersion is the current version of the library, usually following MAJOR.MINOR schema. $gdxVersion is the LibGDX version used to build (and required by) the library. You can check the current library version here - or you can use the snapshots.

GWT module:

        <inherits name='com.github.czyzby.lml.vis.GdxLmlVis' />

On GWT, you might also want to include sources of gdx-lml-vis and currently used VisUI library version.

Usage

Start with LML tutorial - gdx-lml-vis works pretty much like regular LML, it just parses templates to different actors, provides additional widgets and contains default skins. Make sure to check out the example project and VisUI features.

Upgrading regular gdx-lml to gdx-lml-vis

Instead of building your parser with Lml class (or LmlParserBuilder), use VisLml (or VisLmlParserBuilder). Everything else is pretty straightforward: VisLmlSyntax overrides default Scene2D actors with improved VisUI widgets, so you can use all of the standard tags. Your existing LML templates should work out of the box - you might only need to change style names here and there, since VisUI uses its own custom Skin.

Non-GWT features

To add non-GWT features (like the FileChooser support or various file validators from FormValidator class), use ExtendedVisLml#extend(LmlParser) method. This will register all the extra attributes and tags at the cost of nasty compilation errors on GWT platform.

Including gdx-lml-vis in Autumn MVC

In one of your components (possibly in a configuration component, if you have one), include an annotated field with syntax instance:

        @LmlParserSyntax VisLmlSyntax syntax = new VisLmlSyntax();

Make sure that you call VisUI.load() and register Vis skin in LML parser. This can be easily done with an initiation method:

        @Initiate(priority = AutumnActionPriority.TOP_PRIORITY) // ...or custom, higher.
        private void initiate(final SkinService skinService) {
            VisUI.load(); // VisUI.load(Gdx.files.internal("path/to/your/skin.json"));
            skinService.addSkin("default", VisUI.getSkin());
        }

By using SkinService#addSkin method, the disposing of VisUI skin and registering it in LML parser is already handled for you. Still, you might also want to manually dispose of the ColorPicker instance (as it is reused for performance reasons) if you ever used one:

        @Destroy
        public static void destroyColorPicker() {
            ColorPickerContainer.dispose();
        }

Note that by making the method static, instance of the class containing the method will not be kept, so it can be safely garbage collected after application initiation. This is very useful if you want to keep such settings in a single configuration class.

What's new

Make sure to check gdx-lml changes as well!

1.8 -> 1.9

  • showSelectionCheckboxes attribute added to FileChooser tag.
  • disabled attribute added to Spinner tag.
  • verticalCollapsible alias added for CollapsibleWidget tag.
  • HorizontalCollapsibleWidget tag support. Aliases: horizontalCollapsible, horizontalCollapsibleWidget, attributes: collapse, collapsed (boolean).

1.7 -> 1.8

  • Added support for new VisUI actors: BusyBar, MultiSplitPane, ScrollableTextArea and HighlightTextArea. Usage examples are present in gdx-lml-vis-tests.
  • Added sorting, sortingOrderAscending, saveLastDirectory and focusFileScrollPaneOnShow attributes to FileChooser tag accessible through ExtendedVisLml.
  • Added menuListener attribute to menuBar, popupMenu and menu tags.
  • ListView now supports style attribute, which consumes name of a ListViewStyle stored in the Skin.
  • Spinner tag now supports textFieldEventPolicy attribute.

1.6 -> 1.7

  • Removed NumberSelector support, as it is deprecated. Use Spinner instead.
  • Since main tables of TabbedPane instances now share a common class - TabbedPaneTable - pane's attributes support was improved. TabbedPane-specific attributes should no longer be proposed by DTD for all Table-extending widgets.
  • Tooltips created with visTooltip tag are now properly packed.
  • visTooltip attribute added. Expects a string. Attaches a simple Tooltip with default style and a single label (parsed attribute value) to the chosen actor. This is a VisUI-based equivalent of tooltip attribute.
  • <toast> tag added to support the new Toast widget, which allows to display simple messages on the screen. Since toasts shouldn't be added directly to stage, they must be put in a <isolate> tag and manually added to the stage using a ToastManager instance. See gdx-lml-vis-tests for a usage example.
  • readOnly, enterKeyFocusTraversal attributes added to text field and area tags.
  • mouseMoveFadeOut attribute added to VisUI tooltip tags.
  • favoriteFolderButtonVisible, prefsName, fileTypeFilter attributes added to <fileChooser> tag.
  • iconProvider attribute of FileChooser tag now requires an action ID of method that returns FileIconProvider instance due to file chooser refactor.
  • Items sizes in grid groups now use floats instead of ints.

1.5 -> 1.6

  • Macro marker was changed from @ to :. While it required to switch a single character in the actual source code, this is actually a major update. This change breaks all LML templates that used any macro tags. @ was a poor choice in the first place: it can be confused with the i18n bundle marker (also @) and is not a valid XML character. Since DTD supported was added, invalid macro sign was no longer an option. Quick conversion tip: replace <@ and </@ with <: and </: in all *.lml files.
  • Removed /* alias for comment macro. Since DTD creator was added to LML, now it is possible to create templates that are somewhat-valid XML files. /* was the only default tag that used forbidden XML characters.
  • This version brought a lot of syntax additions to make LML more XML-friendly. Thanks to the new named macro attributes, LML templates can now be valid XML without sacrificing the utility that macros bring. Make sure to go through gdx-lml changes for more info.
  • progressBar and slider tags, previously completely non-parental, can parse text between their tags - provided that it's a valid float. The parsed number will be set their initial value. Note that it's not a simple value attribute alias: value attribute is parsed before the actor is created, so it cannot trigger any registered change listeners. On the other hand, data between tags is parsed after actor is created (and has processed its attributes), so it can trigger the listeners.
  • Note that many tag aliases were removed in gdx-lml in this version. VisLmlSyntax was updated to reflect the changes. Go through its sources to check current tag, macro and attribute aliases. Thanks to the aliases removal, DTD file went down to about 30000 lines (with comments generated).
  • FloatingGroup support through floatingGroup tag. This group allows you to set absolute sizes and positions to your actors. Drag pane tag supports this group through type="floating".
  • Now validatable text fields do not have to be direct children of forms - form validators will recursively search through its children and automatically add all validatables to form.
  • Since tables now are not automatically packed, visTooltip needs pack="true" attribute to properly expand its background over the whole area. This is considered a minor bug and will be fixed in the next version.

Archive

Older change logs are available in CHANGES.md file.