/*
* Apache License
* Version 2.0, January 2004
* http://www.apache.org/licenses/
*
* TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
*
* 1. Definitions.
*
* "License" shall mean the terms and conditions for use, reproduction,
* and distribution as defined by Sections 1 through 9 of this document.
*
* "Licensor" shall mean the copyright owner or entity authorized by
* the copyright owner that is granting the License.
*
* "Legal Entity" shall mean the union of the acting entity and all
* other entities that control, are controlled by, or are under common
* control with that entity. For the purposes of this definition,
* "control" means (i) the power, direct or indirect, to cause the
* direction or management of such entity, whether by contract or
* otherwise, or (ii) ownership of fifty percent (50%) or more of the
* outstanding shares, or (iii) beneficial ownership of such entity.
*
* "You" (or "Your") shall mean an individual or Legal Entity
* exercising permissions granted by this License.
*
* "Source" form shall mean the preferred form for making modifications,
* including but not limited to software source code, documentation
* source, and configuration files.
*
* "Object" form shall mean any form resulting from mechanical
* transformation or translation of a Source form, including but
* not limited to compiled object code, generated documentation,
* and conversions to other media types.
*
* "Work" shall mean the work of authorship, whether in Source or
* Object form, made available under the License, as indicated by a
* copyright notice that is included in or attached to the work
* (an example is provided in the Appendix below).
*
* "Derivative Works" shall mean any work, whether in Source or Object
* form, that is based on (or derived from) the Work and for which the
* editorial revisions, annotations, elaborations, or other modifications
* represent, as a whole, an original work of authorship. For the purposes
* of this License, Derivative Works shall not include works that remain
* separable from, or merely link (or bind by name) to the interfaces of,
* the Work and Derivative Works thereof.
*
* "Contribution" shall mean any work of authorship, including
* the original version of the Work and any modifications or additions
* to that Work or Derivative Works thereof, that is intentionally
* submitted to Licensor for inclusion in the Work by the copyright owner
* or by an individual or Legal Entity authorized to submit on behalf of
* the copyright owner. For the purposes of this definition, "submitted"
* means any form of electronic, verbal, or written communication sent
* to the Licensor or its representatives, including but not limited to
* communication on electronic mailing lists, source code control systems,
* and issue tracking systems that are managed by, or on behalf of, the
* Licensor for the purpose of discussing and improving the Work, but
* excluding communication that is conspicuously marked or otherwise
* designated in writing by the copyright owner as "Not a Contribution."
*
* "Contributor" shall mean Licensor and any individual or Legal Entity
* on behalf of whom a Contribution has been received by Licensor and
* subsequently incorporated within the Work.
*
* 2. Grant of Copyright License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* copyright license to reproduce, prepare Derivative Works of,
* publicly display, publicly perform, sublicense, and distribute the
* Work and such Derivative Works in Source or Object form.
*
* 3. Grant of Patent License. Subject to the terms and conditions of
* this License, each Contributor hereby grants to You a perpetual,
* worldwide, non-exclusive, no-charge, royalty-free, irrevocable
* (except as stated in this section) patent license to make, have made,
* use, offer to sell, sell, import, and otherwise transfer the Work,
* where such license applies only to those patent claims licensable
* by such Contributor that are necessarily infringed by their
* Contribution(s) alone or by combination of their Contribution(s)
* with the Work to which such Contribution(s) was submitted. If You
* institute patent litigation against any entity (including a
* cross-claim or counterclaim in a lawsuit) alleging that the Work
* or a Contribution incorporated within the Work constitutes direct
* or contributory patent infringement, then any patent licenses
* granted to You under this License for that Work shall terminate
* as of the date such litigation is filed.
*
* 4. Redistribution. You may reproduce and distribute copies of the
* Work or Derivative Works thereof in any medium, with or without
* modifications, and in Source or Object form, provided that You
* meet the following conditions:
*
* (a) You must give any other recipients of the Work or
* Derivative Works a copy of this License; and
*
* (b) You must cause any modified files to carry prominent notices
* stating that You changed the files; and
*
* (c) You must retain, in the Source form of any Derivative Works
* that You distribute, all copyright, patent, trademark, and
* attribution notices from the Source form of the Work,
* excluding those notices that do not pertain to any part of
* the Derivative Works; and
*
* (d) If the Work includes a "NOTICE" text file as part of its
* distribution, then any Derivative Works that You distribute must
* include a readable copy of the attribution notices contained
* within such NOTICE file, excluding those notices that do not
* pertain to any part of the Derivative Works, in at least one
* of the following places: within a NOTICE text file distributed
* as part of the Derivative Works; within the Source form or
* documentation, if provided along with the Derivative Works; or,
* within a display generated by the Derivative Works, if and
* wherever such third-party notices normally appear. The contents
* of the NOTICE file are for informational purposes only and
* do not modify the License. You may add Your own attribution
* notices within Derivative Works that You distribute, alongside
* or as an addendum to the NOTICE text from the Work, provided
* that such additional attribution notices cannot be construed
* as modifying the License.
*
* You may add Your own copyright statement to Your modifications and
* may provide additional or different license terms and conditions
* for use, reproduction, or distribution of Your modifications, or
* for any such Derivative Works as a whole, provided Your use,
* reproduction, and distribution of the Work otherwise complies with
* the conditions stated in this License.
*
* 5. Submission of Contributions. Unless You explicitly state otherwise,
* any Contribution intentionally submitted for inclusion in the Work
* by You to the Licensor shall be under the terms and conditions of
* this License, without any additional terms or conditions.
* Notwithstanding the above, nothing herein shall supersede or modify
* the terms of any separate license agreement you may have executed
* with Licensor regarding such Contributions.
*
* 6. Trademarks. This License does not grant permission to use the trade
* names, trademarks, service marks, or product names of the Licensor,
* except as required for reasonable and customary use in describing the
* origin of the Work and reproducing the content of the NOTICE file.
*
* 7. Disclaimer of Warranty. Unless required by applicable law or
* agreed to in writing, Licensor provides the Work (and each
* Contributor provides its Contributions) on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied, including, without limitation, any warranties or conditions
* of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
* PARTICULAR PURPOSE. You are solely responsible for determining the
* appropriateness of using or redistributing the Work and assume any
* risks associated with Your exercise of permissions under this License.
*
* 8. Limitation of Liability. In no event and under no legal theory,
* whether in tort (including negligence), contract, or otherwise,
* unless required by applicable law (such as deliberate and grossly
* negligent acts) or agreed to in writing, shall any Contributor be
* liable to You for damages, including any direct, indirect, special,
* incidental, or consequential damages of any character arising as a
* result of this License or out of the use or inability to use the
* Work (including but not limited to damages for loss of goodwill,
* work stoppage, computer failure or malfunction, or any and all
* other commercial damages or losses), even if such Contributor
* has been advised of the possibility of such damages.
*
* 9. Accepting Warranty or Additional Liability. While redistributing
* the Work or Derivative Works thereof, You may choose to offer,
* and charge a fee for, acceptance of support, warranty, indemnity,
* or other liability obligations and/or rights consistent with this
* License. However, in accepting such obligations, You may act only
* on Your own behalf and on Your sole responsibility, not on behalf
* of any other Contributor, and only if You agree to indemnify,
* defend, and hold each Contributor harmless for any liability
* incurred by, or claims asserted against, such Contributor by reason
* of your accepting any such warranty or additional liability.
*
* END OF TERMS AND CONDITIONS
*
* APPENDIX: How to apply the Apache License to your work.
*
* To apply the Apache License to your work, attach the following
* boilerplate notice, with the fields enclosed by brackets "{}"
* replaced with your own identifying information. (Don't include
* the brackets!) The text should be enclosed in the appropriate
* comment syntax for the file format. We also recommend that a
* file or class name and description of purpose be included on the
* same "printed page" as the copyright notice for easier
* identification within third-party archives.
*
* Copyright $date.year Alan Tai
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.lib.widget.verticalmarqueetextview;
import android.content.Context;
import android.content.res.TypedArray;
import android.graphics.Typeface;
import android.os.Handler;
import android.os.Looper;
import android.util.AttributeSet;
import android.util.Log;
import android.view.Gravity;
import android.view.ViewGroup;
import android.view.Window;
import android.widget.ScrollView;
import android.widget.TextView;
/**
* A {@link TextView} with vertical marquee effect. The animation speed can be set using
* {@link #setMarqueeSpeed(int)} or through XML declaration. By default, the marquee effect
* animation starts automatically when this view is attached to a {@link Window}.
* Set {@code autoStartMarquee} to {@code false} to disable this behavior.
*/
public class VerticalMarqueeTextView extends ScrollView {
private static final String TAG = VerticalMarqueeTextView.class.getName();
private static final int MIN_MARQUEE_SPEED = 1;
private static final int MAX_MARQUEE_SPEED = 1000;
private static final double SECOND = 1000;
private Handler handler;
private TextView textView;
private int marqueeSpeed;
private boolean marqueeStarted;
private boolean marqueePaused;
private boolean isAnimating;
private int unitDisplacement;
public VerticalMarqueeTextView(final Context context) {
super(context);
this.init(context, null);
}
public VerticalMarqueeTextView(final Context context, final AttributeSet attrs) {
super(context, attrs);
this.init(context, attrs);
}
public VerticalMarqueeTextView(final Context context, final AttributeSet attrs, final int defStyle) {
super(context, attrs, defStyle);
this.init(context, attrs);
}
/**
* Returns the text content of this text view.
* @return The text content of this text view.
*/
public CharSequence getText() {
return this.textView.getText();
}
/**
* Sets a string for this text view.
* @param text The text to set.
*/
public void setText(final CharSequence text) {
this.textView.setText(text);
}
/**
* Returns the speed of the marquee effect animation.
* @return The speed of the marquee effect animation.
*/
public int getMarqueeSpeed() {
return this.marqueeSpeed;
}
/**
* Sets the speed of the marquee effect animation. Valid range is [1, 1000].
* @param marqueeSpeed The speed of the marquee effect animation to set. Valid range is [1, 1000].
*/
public void setMarqueeSpeed(final int marqueeSpeed) {
this.marqueeSpeed = Math.min(VerticalMarqueeTextView.MAX_MARQUEE_SPEED, Math.max(VerticalMarqueeTextView.MIN_MARQUEE_SPEED, marqueeSpeed));
}
/**
* Starts the marquee effect animation.
*/
public void startMarquee() {
this.marqueeStarted = true;
this.marqueePaused = false;
if (!this.isAnimating) {
this.isAnimating = true;
new Thread(new Runnable() {
@Override
public void run() {
VerticalMarqueeTextView.this.animateTextView();
}
}).start();
}
}
/**
* Stops the marquee effect animation.
*/
public void stopMarquee() {
this.marqueeStarted = false;
}
@Override
protected void onAttachedToWindow() {
super.onAttachedToWindow();
if (this.marqueeStarted) {
this.startMarquee();
}
}
@Override
protected void onDetachedFromWindow() {
super.onDetachedFromWindow();
this.marqueePaused = true;
}
@Override
protected float getTopFadingEdgeStrength() {
if (this.getChildCount() == 0) {
return 0;
}
final int length = this.getVerticalFadingEdgeLength();
final int scrollY = this.textView.getScrollY();
if (scrollY < length) {
return scrollY / (float)length;
}
return 1;
}
private void init(final Context context, final AttributeSet attrs) {
this.handler = new Handler(Looper.getMainLooper());
// 1dp per cycle
this.unitDisplacement = Math.round(this.getResources().getDisplayMetrics().density);
this.textView = new TextView(context);
this.textView.setGravity(Gravity.CENTER);
this.addView(this.textView, new ViewGroup.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT));
this.textView.scrollTo(0, -this.getHeight());
this.setHorizontalScrollBarEnabled(false);
this.setVerticalScrollBarEnabled(false);
this.setHorizontalFadingEdgeEnabled(false);
this.setVerticalFadingEdgeEnabled(true);
this.setFadingEdgeLength(30);
if (attrs != null) {
final TypedArray array = context.obtainStyledAttributes(attrs, R.styleable.VerticalMarqueeTextView, 0, 0);
this.textView.setText(array.getText(R.styleable.VerticalMarqueeTextView_text));
final int textRes = array.getResourceId(R.styleable.VerticalMarqueeTextView_text, 0);
if (textRes > 0) {
this.textView.setText(array.getText(textRes));
}
this.textView.setTextColor(array.getColor(R.styleable.VerticalMarqueeTextView_textColor, context.getResources().getColor(android.R.color.primary_text_light)));
final int textColorRes = array.getResourceId(R.styleable.VerticalMarqueeTextView_textColor, 0);
if (textColorRes > 0) {
this.textView.setTextColor(context.getResources().getColor(textColorRes));
}
final float textSize = array.getDimension(R.styleable.VerticalMarqueeTextView_textSize, 0);
if (textSize > 0) {
this.textView.setTextSize(textSize);
}
final int textSizeRes = array.getResourceId(R.styleable.VerticalMarqueeTextView_textSize, 0);
if (textSizeRes > 0) {
this.textView.setTextSize(context.getResources().getDimension(textSizeRes));
}
final int typeface = array.getInt(R.styleable.VerticalMarqueeTextView_typeface, 0);
this.textView.setTypeface(typeface == 1 ? Typeface.SANS_SERIF : typeface == 2 ? Typeface.SERIF : typeface == 3 ? Typeface.MONOSPACE : Typeface.DEFAULT, array.getInt(R.styleable.VerticalMarqueeTextView_textStyle, Typeface.NORMAL));
final int textAppearance = array.getResourceId(R.styleable.VerticalMarqueeTextView_textAppearance, 0);
if (textAppearance > 0) {
this.textView.setTextAppearance(context, textAppearance);
}
this.setMarqueeSpeed(array.getInt(R.styleable.VerticalMarqueeTextView_marqueeSpeed, 0));
final int marqueeSpeedRes = array.getResourceId(R.styleable.VerticalMarqueeTextView_marqueeSpeed, 0);
if (marqueeSpeedRes > 0) {
this.setMarqueeSpeed(context.getResources().getInteger(marqueeSpeedRes));
}
final boolean autoStartMarquee = array.getBoolean(R.styleable.VerticalMarqueeTextView_autoStartMarquee, true);
if (autoStartMarquee) {
this.marqueeStarted = true;
}
array.recycle();
}
}
private void animateTextView() {
final Runnable runnable = new VerticalMarqueeTextView.MarqueeRunnable(this.textView);
long previousMillis = 0;
while (VerticalMarqueeTextView.this.marqueeStarted && !VerticalMarqueeTextView.this.marqueePaused) {
final long currentMillis = System.currentTimeMillis();
if (currentMillis >= previousMillis) {
VerticalMarqueeTextView.this.handler.post(runnable);
previousMillis = currentMillis + (long)(VerticalMarqueeTextView.SECOND / VerticalMarqueeTextView.this.marqueeSpeed);
}
try {
Thread.sleep((long)(VerticalMarqueeTextView.SECOND / VerticalMarqueeTextView.this.marqueeSpeed));
} catch (final InterruptedException e) {
Log.v(VerticalMarqueeTextView.TAG, e.getMessage(), e);
}
}
this.isAnimating = false;
}
private final class MarqueeRunnable implements Runnable {
private final ViewGroup parent;
private final TextView textView;
/**
* Creates a new instance of {@link VerticalMarqueeTextView.MarqueeRunnable}.
* @param textView The {@link TextView} to apply marquee effect.
*/
public MarqueeRunnable(final TextView textView) {
this.parent = (ViewGroup)textView.getParent();
this.textView = textView;
}
@Override
public void run() {
final int height = this.heightOf(this.textView);
final int parentHeight = this.parent.getHeight();
if (height > 0 && parentHeight > 0 && height > parentHeight) {
if (this.textView.getScrollY() >= height) {
this.textView.scrollTo(0, -parentHeight);
} else {
this.textView.scrollBy(0, VerticalMarqueeTextView.this.unitDisplacement);
}
this.textView.invalidate();
}
}
/**
* Returns the standard height (i.e. without text effects such as shadow) of all the text of
* the given {@link TextView}.
* @param textView The {@link TextView} to determine the height of all its text content.
* @return The standard height of all the text content of the given {@link TextView}.
*/
private int heightOf(final TextView textView) {
return textView.getLineCount() > 0 ? textView.getLineHeight() * textView.getLineCount() : 0;
}
}
}
