Home

TweetAppUIKit

Synopsis

A library for Codename One that provides views and models for building Twitter-like native mobile apps (e.g. for iOS, Android, etc..).

Requirements

This library is intended to be used in Codename One applications using the CodeRAD framework. As such, you will need a Codename One maven project with CodeRAD dependencies.

Installation

Add the Maven dependency for the tweet-app-ui-kit-lib in your project’s common/pom.xml file in its <dependencies> section:

<dependency>
    <groupId>com.codenameone</groupId>
    <artifactId>tweet-app-ui-kit-lib</artifactId>
    <version>1.0-pre1</version>
    <type>pom</type>
</dependency>

Entity Classes

Tweet (javadoc)

Encapsulates a "Tweet", which is similar to a comment or news item that you would find in a News feed.

TWTAuthor (javadoc)

Encapsulates the author of a tweet, including name, ID, and avatar image.

TWTUserProfile

Encapsulates a user profile, including things like username and email.

Views (javadocs)

TweetListView <tweetListView>

A news feed component that renders a list of Tweet entities in a way that resembles the Twitter mobile app.

TweetRowView <tweetRowView>

The component used by TweetListView to render its rows.

TWTSearchButton `<twtsearchButton>

A button that looks like a search field.

TWTSideBarView <twtsideBarView>

A component that resembles the Twitter app sidebar, with user avatar, some stats (e.g. follower count), and navigation menu options.

TWTGlobalTabs <globalTabs>

A component providing the Twitter-style global navigation tabs that appear at the bottom of the app.

TWTTitleComponent <twtTitle>

A twitter-style title component.

TweetDetailView <tweetDetailView> (javadoc)

view for showing a "tweet" details. This is the logical view that would be shown when a user clicks on a "tweet" in the TweetListView to see an expanded version of the tweet.

TWTNewsList <twtnewsList> (javadoc)

A view for displaying a list of news items. This is similar to TweetListView, except this more closely resembles the "News" section of the Twitter mobile app rather than a "tweet" list. E.g. it displays a headline, a news source, and an image associated with the headline.

TWTProfileList <txtprofileList> (javadoc)

A component that renders a list of user profiles as either rows or badges. This is used by the TWTSearchView in TWTProfileList.ListStyle.Badges mode to render the list of recent profiles visited.

TWTSearchButton <twtsearchButton> (javadoc)

This component is a button that is made to look like a search field. The idea is that when the user presses the button, it will transition to a new form which has an actual search field. The look of this component is meant match the TWTSearchField component.

TWTSearchField <twtsearchField> (javadoc)

The search field used by the TWTSearchView. This includes a TextField styled like the search field in the Twitter mobile app. It also includes a "clear" button to clear out the contents of the search and start again.

TWTSettingsForm <twtsettingsForm> (javadoc)

A settings form similar to the settings form in the Twitter mobile app. This extends SettingsForm and adds the "TWT" UIID prefix so that it can override styles in the twitter stylesheet.

TWTTabsView <twttabsView> (javadoc)

A subclass of TabsEntityView that injects Twitter-ish tab styles.

TWTTitleComponent <twtTitle> (javadoc)

This component is the equivalent of the "ToolBar" for TweetAppUIKit apps. It will display either a "Back" button, or the current user’s avatar in the upper left, depending on context, The remainder of the component is filled with the "main content", which is passed to the component constructor.