Word (WordCram API)

java.lang.Object
- wordcram.Word

All Implemented Interfaces:

java.lang.Comparable<Word>
```
public class Word
extends java.lang.Object
implements java.lang.Comparable<Word>
```
A weighted word, for rendering in the word cloud image.
Each Word object has a word String, and its associated weight, and it's constructed with these two things.
Hand-crafting Your Words
If you're creating your own Word[] to pass to the WordCram (rather than using something like WordCram.fromWebPage(String)), you can specify how a Word should be rendered: set a Word's font, size, etc:
```
 Word w = new Word("texty", 20);
 w.setFont(createFont("myFontName", 1));
 w.setAngle(radians(45));
 
```
Any values set on a Word will override the corresponding component (WordColorer, WordAngler, etc) - it won't even be called for that word.
Word Properties
A word can also have properties. If you're creating custom components, you might want to send other information along with the word, for the components to use:
```
 Word strawberry = new Word("strawberry", 10);
 strawberry.setProperty("isFruit", true);

 Word pea = new Word("pea", 10);
 pea.setProperty("isFruit", false);

 new WordCram(this)
   .fromWords(new Word[] { strawberry, pea })
   .withColorer(new WordColorer() {
      public int colorFor(Word w) {
        if (w.getProperty("isFruit") == true) {
          return color(255, 0, 0);
        }
        else {
          return color(0, 200, 0);
        }
      }
    });
 
```

Field Summary

Fields
Modifier and Type Field and Description

float weight

java.lang.String word

Fields
Modifier and Type	Field and Description
`float`	`weight`
`java.lang.String`	`word`

Constructor Summary

Constructors
Constructor and Description

Word(java.lang.String word, float weight)

Constructors
Constructor and Description
`Word(java.lang.String word, float weight)`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`compareTo(Word w)` Compares Words based on weight only.
`java.lang.Object`	`getProperty(java.lang.String propertyName)` Get a property value from this Word, for a WordColorer, a WordPlacer, etc.
`float`	`getRenderedAngle()` Get the angle the Word was rendered at: either the value passed to setAngle(), or the value returned from the WordAngler.
`int`	`getRenderedColor()` Get the color the Word was rendered in: either the value passed to setColor(), or the value returned from the WordColorer.
`processing.core.PFont`	`getRenderedFont()` Get the font the Word was rendered in: either the value passed to setFont(), or the value returned from the WordFonter.
`float`	`getRenderedHeight()` Gets the height, in pixels, of the java.awt.Shape that will be rendered for this Word, based on the Font, Angle, and Size for this Word.
`processing.core.PVector`	`getRenderedPlace()` Get the final place the Word was rendered at, or null if it couldn't be placed.
`float`	`getRenderedSize()` Get the size the Word was rendered at: either the value passed to setSize(), or the value returned from the WordSizer.
`float`	`getRenderedWidth()` Gets the width, in pixels, of the java.awt.Shape that will be rendered for this Word, based on the Font, Angle, and Size for this Word.
`processing.core.PVector`	`getTargetPlace()` Get the place the Word was supposed to be rendered at: either the value passed to setPlace(), or the value returned from the WordPlacer.
`Word`	`setAngle(float angle)` Set the angle this Word should be rendered at - WordCram won't even call the WordAngler.
`Word`	`setColor(int color)` Set the color this Word should be rendered in - WordCram won't call the WordColorer.
`Word`	`setFont(processing.core.PFont font)` Set the font this Word should be rendered in - WordCram won't call the WordFonter.
`Word`	`setPlace(float x, float y)` Set the place this Word should be rendered at - WordCram won't call the WordPlacer.
`Word`	`setPlace(processing.core.PVector place)` Set the place this Word should be rendered at - WordCram won't call the WordPlacer.
`Word`	`setProperty(java.lang.String propertyName, java.lang.Object propertyValue)` Set a property on this Word, to be used by a WordColorer, a WordPlacer, etc, down the line.
`Word`	`setSize(float size)` Set the size this Word should be rendered at - WordCram won't even call the WordSizer.
`java.lang.String`	`toString()` Displays the word, and its weight (in parentheses).
`boolean`	`wasPlaced()` Indicates whether the Word was placed successfully.
`boolean`	`wasSkipped()` Indicates whether the Word was skipped.
`java.lang.Integer`	`wasSkippedBecause()` Tells you why this Word was skipped.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - word
```
public java.lang.String word
```
  - weight
```
public float weight
```
- Constructor Detail
  - Word
```
public Word(java.lang.String word,
    float weight)
```
- Method Detail
  - setSize
```
public Word setSize(float size)
```
    Set the size this Word should be rendered at - WordCram won't even call the WordSizer.
    
    Returns:
    the Word, for more configuration
  - setAngle
```
public Word setAngle(float angle)
```
    Set the angle this Word should be rendered at - WordCram won't even call the WordAngler.
    
    Returns:
    the Word, for more configuration
  - setFont
```
public Word setFont(processing.core.PFont font)
```
    Set the font this Word should be rendered in - WordCram won't call the WordFonter.
    
    Returns:
    the Word, for more configuration
  - setColor
```
public Word setColor(int color)
```
    Set the color this Word should be rendered in - WordCram won't call the WordColorer.
    
    Returns:
    the Word, for more configuration
  - setPlace
```
public Word setPlace(processing.core.PVector place)
```
    Set the place this Word should be rendered at - WordCram won't call the WordPlacer.
    
    Returns:
    the Word, for more configuration
  - setPlace
```
public Word setPlace(float x,
            float y)
```
    Set the place this Word should be rendered at - WordCram won't call the WordPlacer.
    
    Returns:
    the Word, for more configuration
  - getRenderedSize
```
public float getRenderedSize()
```
    Get the size the Word was rendered at: either the value passed to setSize(), or the value returned from the WordSizer.
    
    Returns:
    the rendered size
  - getRenderedAngle
```
public float getRenderedAngle()
```
    Get the angle the Word was rendered at: either the value passed to setAngle(), or the value returned from the WordAngler.
    
    Returns:
    the rendered angle
  - getRenderedFont
```
public processing.core.PFont getRenderedFont()
```
    Get the font the Word was rendered in: either the value passed to setFont(), or the value returned from the WordFonter.
    
    Returns:
    the rendered font
  - getRenderedColor
```
public int getRenderedColor()
```
    Get the color the Word was rendered in: either the value passed to setColor(), or the value returned from the WordColorer.
    
    Returns:
    the rendered color
  - getTargetPlace
```
public processing.core.PVector getTargetPlace()
```
    Get the place the Word was supposed to be rendered at: either the value passed to setPlace(), or the value returned from the WordPlacer.
  - getRenderedPlace
```
public processing.core.PVector getRenderedPlace()
```
    Get the final place the Word was rendered at, or null if it couldn't be placed. It returns the original target location (which is either the value passed to setPlace(), or the value returned from the WordPlacer), plus the nudge vector returned by the WordNudger.
    
    Returns:
    If word was placed, it's the (x,y) coordinates of the word's final location; else it's null.
  - wasPlaced
```
public boolean wasPlaced()
```
    Indicates whether the Word was placed successfully. It's the same as calling word.getRenderedPlace() != null. If this returns false, it's either because a) WordCram didn't get to this Word yet, or b) it was skipped for some reason (see wasSkipped() and wasSkippedBecause()).
    
    Returns:
    true only if the word was placed.
  - wasSkipped
```
public boolean wasSkipped()
```
    Indicates whether the Word was skipped.
    
    Returns:
    true if the word was skipped
    See Also:
    wasSkippedBecause()
  - wasSkippedBecause
```
public java.lang.Integer wasSkippedBecause()
```
    Tells you why this Word was skipped. If the word was skipped, then this will return an Integer, which will be one of WordCram.WAS_OVER_MAX_NUMBER_OF_WORDS, WordCram.SHAPE_WAS_TOO_SMALL, or WordCram.NO_SPACE. If the word was successfully placed, or WordCram hasn't gotten to this word yet, this will return null.
    
    Returns:
    the code for the reason the word was skipped, or null if it wasn't skipped.
  - getProperty
```
public java.lang.Object getProperty(java.lang.String propertyName)
```
    Get a property value from this Word, for a WordColorer, a WordPlacer, etc.
    
    Parameters:
    propertyName -
    
    Returns:
    the value of the property, or null, if it's not there.
  - setProperty
```
public Word setProperty(java.lang.String propertyName,
               java.lang.Object propertyValue)
```
    Set a property on this Word, to be used by a WordColorer, a WordPlacer, etc, down the line.
    
    Parameters:
    propertyName -
    propertyValue -
    
    Returns:
    the Word, for more configuration
  - toString
```
public java.lang.String toString()
```
    Displays the word, and its weight (in parentheses). new Word("hello", 1.3).toString() will return "hello (0.3)".
    
    Overrides:
    
    toString in class java.lang.Object
  - compareTo
```
public int compareTo(Word w)
```
    Compares Words based on weight only. Words with equal weight are arbitrarily sorted.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Word>
  - getRenderedWidth
```
public float getRenderedWidth()
```
    Gets the width, in pixels, of the java.awt.Shape that will be rendered for this Word, based on the Font, Angle, and Size for this Word. If that all hasn't been figured out yet, then this returns 0.
    
    Returns:
    The width in pixels of this Word's Shape, or 0, if it hasn't been rendered yet.
    See Also:
    getRenderedHeight()
  - getRenderedHeight
```
public float getRenderedHeight()
```
    Gets the height, in pixels, of the java.awt.Shape that will be rendered for this Word, based on the Font, Angle, and Size for this Word. If that all hasn't been figured out yet, then this returns 0.
    
    Returns:
    The height in pixels of this Word's Shape, or 0, if it hasn't been rendered yet.
    See Also:
    getRenderedWidth()

Class Word

Hand-crafting Your Words

Word Properties

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

word

weight

Constructor Detail

Word

Method Detail

setSize

setAngle

setFont

setColor

setPlace

setPlace

getRenderedSize

getRenderedAngle

getRenderedFont

getRenderedColor

getTargetPlace

getRenderedPlace

wasPlaced

wasSkipped

wasSkippedBecause

getProperty

setProperty

toString

compareTo

getRenderedWidth

getRenderedHeight