From wiki.ginstr.com
Revision as of 12:48, 22 June 2016 by Mark (talk | contribs) (Created page with "<div style="float:right; clear:both; margin-left:0.5em;">__TOC__</div> ==Widgets== Widgets can be divided in two groups: ::;1. Android widgets : all [http://developer.android....")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Widgets

Widgets can be divided in two groups:

1. Android widgets 
all native Android widgets (look for subtitle “Classes”). Widgets are provided by Android system.
2. ginstr widgets 
custom made widgets. They can be composite widgets that consist of multiple Android views or a single view with special functionality.

Each file in “layout” folder is called layout. Mandatory layouts as mentioned before are “activity.xml” and “start.xml”. These layouts consist of widgets. Layout can have one top element (widget) as mentioned before.

Widgets can be divided by nesting:

1. Container widgets (ViewGroups) 
those widgets are used as containers for other widgets. The purpose is positioning assistance and layout organization. The most important are: LinearLayout, RelativeLayout, ScrollView (can have one child), FrameLayout. More are mentioned here.
2. Action widgets 
widgets that can’t nest or contain widgets within them. These widgets are used for providing functionality to app (i.e. input text, display text, call phone, send text message…), some of those are (TextView, ImageView, EditText, EnEditText, EnMediaAction…)

Widget Library contains all custom ginstr widgets that contain features not provided out of the box by Android.

Attributes

Attributes define how each widget behaves and what it looks like. Android widgets have attributes described for each widget for example TextView, ImageView, EditText (look under XML attributes and Inherited XML attributes). Each attribute has a description what its function is. This is provided for all Android widgets in Android documentation.

Example Android widget with attributes:
File:attributes example.png
16.Attributes example

To use ginstr namespace attributes user has to define custom namespace in top (root) element (widget) of the layout. xmlns:ek=http://schemas.ginstr.com/ginstr. To define custom attribute following syntax is used, gn:customAttributeName=“attributeValue“

Example of a ginstr widget with attributes:
File:ginstr widget with attributes.png
17. ginstr widget with attributes

Mandatory attributes

!IMPORTANT! Each widget has to have android:layout_width, android:layout_height defined. Custom widgets need custom ginstr attribute defined to work properly, check layout configuration of each widget. Attribute with asterisk (*) is a mandatory parameter when creating widget.

Widgets positioning

One of the most important things is how to handle widget positioning within container widgets. Positioning depends on each widget within a container which depends on the container which contains it. If a widget is contained for example in LinearLayout it will not have the same positioning options as in RelativeLayout. For an introduction on the two most common containers read this(linear) and this(relative).

Example: Widget in RelativeLayout has the ability to position itself relative to other views by attribute (example under positions widget containing this attribute to right of widget with id mentioned in attribute)
android:layout_toRightOf=”@+id/idOfAnotherElementInThisContainer”

Practice is needed to learn those few containers and their abilities. With combinations of containers any positioning can be achieved.

Widget data persistence

!IMPORTANT! To enable widgets that retrieve data from a user to retain data between orientation changes a unique id for widget within that layout has to be provided. Id has to be identical in both layouts (landscape/portrait). It is encouraged to use portrait only layout due to better visibility on phone Android devices.

Example:
18. ID for persistence

Widget Library

The table below contains a brief description of all custom ginstr widgets that contain features not provided out of the box by Android. Full details on each widget can be found by clicking on the widget name.

Widget Library
Widget Name Brief Description
TextView Primarily used to display text but can also be used to contain links
Button Standard Android button that can be used with special ginstr abilities
GnEditText Multi-source editText used to enter text data or acquire it from other sources.
GnImageView Android imageView with some additional features
GnPhoneAction Provides phone functionality (initiate phone call, text message/SMS, email, open webpage or download file)
GnMediaAction Provides media functionality (recording of audio, video or photo)
GnMediaGallery Shows media items as images in table view
GnTextView Android TextView with some additional functionality
GnCaptureSignature Captures a signature and save to device
GnCaptureSignatureEmbedded Captures a signature to be drawn on to screen with other widgets
GnDatePicker Provides date entry
GnTimePicker Provides time entry
GnDateTimePicker Provides date and time entry
GnDropDown Provides entry of dropdown values
GnDropDownSelection Extends GnDropDown widget with possibility to select multiple values from dropdown list
GnLogin Provides interface for a user login
GnLogSender Provides option to send log on any screen
GnPreferencesButton Provides a button that when clicked launches preferences activity of GL
GnListView Used to show data in a table appearance
GnCheckBox Provides a checkbox that can be either checked or unchecked
GnChronometer Used to display time elapsed
GnPhoneNumber Provides support to enter phone number data into phone number datatype
GnRadioGroup Container for GnRadioButton widgets
GnRadioButton Used to display a single choice list
GnButton Can be pressed or clicked by the user to perform an action
GnEmail Supports storage and retrieval of email data to/from email database
GnNfcEmulator Simulates NFC scans
GnQrEmulator Simulates QR scans