TextDecorator.java

/*******************************************************************************
 * Copyright (c) 2012,2014 EclipseSource and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *    EclipseSource - initial API and implementation
 ******************************************************************************/
package com.eclipsesource.tabris.widgets.enhancement;


import static com.eclipsesource.tabris.internal.Clauses.whenNull;
import static com.eclipsesource.tabris.internal.DataWhitelist.WhiteListEntry.AUTO_CAPITALIZE;
import static com.eclipsesource.tabris.internal.DataWhitelist.WhiteListEntry.AUTO_CORRECT;
import static com.eclipsesource.tabris.internal.DataWhitelist.WhiteListEntry.KEYBOARD;
import static com.eclipsesource.tabris.internal.DataWhitelist.WhiteListEntry.TEXT_REPLACEMENT;
import static com.eclipsesource.tabris.internal.WidgetsUtil.setData;

import org.eclipse.rap.rwt.RWT;
import org.eclipse.swt.widgets.Text;

import com.eclipsesource.tabris.TabrisClient;


/**
 * @since 0.8
 */
public class TextDecorator extends WidgetDecorator<TextDecorator> {

  private final Text text;

  TextDecorator( Text text ) {
    super( text );
    this.text = text;
  }

  /**
   * <p>
   * Defines the grayed text within a text field. This text will be removed when a user selects the {@link Text}
   * widget.
   * </p>
   *
   * @since 0.8
   */
  public TextDecorator useHintText( String hint ) {
    text.setMessage( hint );
    return this;
  }

  /**
   * <p>
   * Instructs a client to enable/disable auto capitalization on a {@link Text} widget.
   * </p>
   *
   * @since 1.4
   */
  public TextDecorator setAutoCapitalizationEnabled( boolean enabled ) {
    setData( text, AUTO_CAPITALIZE, Boolean.valueOf( enabled ) );
    return this;
  }

  /**
   * <p>
   * Instructs a client to enable/disable auto correction on a {@link Text} widget.
   * </p>
   *
   * @since 1.4
   */
  public TextDecorator setAutoCorrectionEnabled( boolean enabled ) {
    setData( text, AUTO_CORRECT, Boolean.valueOf( enabled ) );
    return this;
  }

  /**
   * <p>
   * Instructs the {@link Text} to open a keyboard with an ascii layout when the user wan't to type text.
   * </p>
   *
   * @since 0.8
   */
  public TextDecorator useAsciiKeyboard() {
    setData( text, KEYBOARD, "ascii" );
    return this;
  }

  /**
   * <p>
   * Instructs the {@link Text} to open a keyboard with a numbers and punctuation layout when the user wan't to
   * type text.
   * </p>
   *
   * @since 0.8
   */
  public TextDecorator useNumbersAndPunctuationKeyboard() {
    setData( text, KEYBOARD, "numbersAndPunctuation" );
    return this;
  }

  /**
   * <p>
   * Instructs the {@link Text} to open a keyboard with an url layout when the user wan't to type text.
   * </p>
   *
   * @since 0.8
   */
  public TextDecorator useUrlKeyboard() {
    setData( text, KEYBOARD, "url" );
    return this;
  }

  /**
   * <p>
   * Instructs the {@link Text} to open a keyboard with a number layout when the user wan't to type text.
   * </p>
   *
   * @since 0.8
   */
  public TextDecorator useNumberKeyboard() {
    setData( text, KEYBOARD, "number" );
    return this;
  }

  /**
   * <p>
   * Instructs the {@link Text} to open a keyboard with a phone layout when the user wan't to type text.
   * </p>
   *
   * @since 0.8
   */
  public TextDecorator usePhoneKeyboard() {
    setData( text, KEYBOARD, "phone" );
    return this;
  }

  /**
   * <p>
   * Instructs the {@link Text} to open a keyboard with an email layout when the user wan't to type text.
   * </p>
   *
   * @since 0.8
   */
  public TextDecorator useEmailKeyboard() {
    setData( text, KEYBOARD, "email" );
    return this;
  }

  /**
   * <p>
   * Instructs the {@link Text} to open a keyboard with a decimal layout when the user wan't to type text.
   * </p>
   *
   * @since 0.8
   */
  public TextDecorator useDecimalKeyboard() {
    setData( text, KEYBOARD, "decimal" );
    return this;
  }

  /**
   * <p>
   * Sets the {@link TextReplacementData} on the decorated {@link Text} widget.
   * </p>
   *
   * @see TextReplacementData
   *
   * @since 1.4
   */
  public TextDecorator setTextReplacement( TextReplacementData data ) {
    whenNull( data ).throwIllegalArgument( "TextReplacementData must not be null" );
    if( RWT.getClient() instanceof TabrisClient ) {
      setData( text, TEXT_REPLACEMENT, data.getId() );
    }
    return this;
  }

}