com.hdcookbook.grin.features
Class SEText

java.lang.Object
  com.hdcookbook.grin.Feature
      com.hdcookbook.grin.features.Text
          com.hdcookbook.grin.features.SEText

All Implemented Interfaces:

Node, SENode, SEScalableNode, SetupClient

public class SEText
extends Text
implements SENode, SEScalableNode

Field Summary

Fields inherited from class com.hdcookbook.grin.features.Text

alignment, background, BASELINE, BOTTOM, colors, fontIndex, LEFT, loopCount, MIDDLE, RIGHT, strings, TOP, vspace, xArg, yArg

Fields inherited from class com.hdcookbook.grin.Feature

name, show

Constructor Summary

SEText(SEShow show)

SEText(SEShow show, java.lang.String name, int x, int y, int alignment, java.lang.String[] strings, int vspace, int fontIndex, java.awt.Color[] colors, int loopCount, java.awt.Color background)

Method Summary

void	accept(SEShowVisitor visitor) Calls the visit method corresponding to this node type.
void	changeFeatureReference(Feature from, Feature to) Change a feature reference from one feature to a new one.
int	getAlignment()
java.awt.Color	getBackground()
java.awt.Color[]	getColors()
int	getFontIndex()
int	getLoopCount()
java.lang.String	getRuntimeClassName() Returns the class that should be constructed at Show runtime to represent this SENode.
java.lang.String[]	getStrings()
int	getVspace()
int	getXArg()
int	getYArg()
void	postProcess(ShowBuilder builder) Do any needed post-processing in this show.
void	scaleBy(int xScale, int yScale, int xOffset, int yOffset) Scale this node by the given scale factor, and apply the given offset.
void	setBackground(java.awt.Color background)
void	setColors(java.awt.Color[] colors)
void	setFontIndex(int index)
void	setStrings(java.lang.String[] strings)
void	setVspace(int vspace)
void	setXArg(int x)
void	setYArg(int y)
java.lang.String	toString()
void	writeInstanceData(GrinDataOutputStream out) Record this node information to the binary file format.

Methods inherited from class com.hdcookbook.grin.features.Text

addDisplayAreas, createClone, destroy, doSomeSetup, getFont, getLineHeight, getText, getX, getY, initialize, markDisplayAreasChanged, needsMoreSetup, nextFrame, paintFrame, readInstanceData, setActivateMode, setSetupMode, setText

Methods inherited from class com.hdcookbook.grin.Feature

activate, addSubgraph, cloneCommands, clonedReference, cloneSubgraph, deactivate, destroyClonedSubgraph, getName, initializeClone, isSetup, makeNewClone, resetFeature, sendFeatureSetup, setName, setup, unsetup

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SEText

public SEText(SEShow show,
              java.lang.String name,
              int x,
              int y,
              int alignment,
              java.lang.String[] strings,
              int vspace,
              int fontIndex,
              java.awt.Color[] colors,
              int loopCount,
              java.awt.Color background)

SEText

public SEText(SEShow show)

Method Detail

getStrings

public java.lang.String[] getStrings()

getVspace

public int getVspace()

getFontIndex

public int getFontIndex()

getColors

public java.awt.Color[] getColors()

getBackground

public java.awt.Color getBackground()

setStrings

public void setStrings(java.lang.String[] strings)

setVspace

public void setVspace(int vspace)

setFontIndex

public void setFontIndex(int index)

setColors

public void setColors(java.awt.Color[] colors)

setBackground

public void setBackground(java.awt.Color background)

getXArg

public int getXArg()

setXArg

public void setXArg(int x)

getYArg

public int getYArg()

setYArg

public void setYArg(int y)

getAlignment

public int getAlignment()

getLoopCount

public int getLoopCount()

writeInstanceData

public void writeInstanceData(GrinDataOutputStream out)
                       throws java.io.IOException

Description copied from interface: SENode

Record this node information to the binary file format. An implementation of this method is recommended to call out.writeSuperClassData(this) as the first line of the method to write out data defined in the base class of this Node type.

Specified by:

writeInstanceData in interface SENode

Parameters:

out - The stream to write out.

Throws:

java.io.IOException - if error occurs.

See Also:

GrinDataOutputStream.writeSuperClassData(Feature), GrinDataOutputStream.writeSuperClassData(RCHandler), GrinDataOutputStream.writeSuperClassData(Segment), GrinDataOutputStream.writeSuperClassData(Command)

getRuntimeClassName

public java.lang.String getRuntimeClassName()

Description copied from interface: SENode

Returns the class that should be constructed at Show runtime to represent this SENode.

Specified by:

getRuntimeClassName in interface SENode

Returns:

String A fully qualified classname of a Node at xlet runtime.

accept

public void accept(SEShowVisitor visitor)

Description copied from interface: SENode

Calls the visit method corresponding to this node type.

If you are defining a user-defined feature, there are some restrictions that you'll want to follow. If your extension is a feature that has children, then you should make it a subclass of one of the built-in feature types, Assembly, Modifer or Group. That's because the GRIN compiler defines visitors that need to visit every node in the tree, but these built-in visitors don't know about your extension types. By making your extension type a subclass of one of the standard ones, and by making your accept() method call either visitAssembly(), visitGroup() or visitUserDefinedModifier(), as appropriate, you'll ensure that all the children get visited.

Specified by:

accept in interface SENode

Parameters:

visitor - SEShowVisitor object.

See Also:

SEShowVisitor

postProcess

public void postProcess(ShowBuilder builder)
                 throws java.io.IOException

Do any needed post-processing in this show. The grin compiler works as follows:

• GRIN source file is read and tree is built in memory
• Forward references are resolved (in multiple passes)
• postProcess() is called on every node. During the call, child feature nodes can be added, and parent features can be injected.
• The double-use checker runs to ensure the graph structure is valid.
• Deferred builders (e.g. TranslatorHelper) are called. Deferred builders cannot make changes to the tree structure.

During the post-process phase, a node can add new features to the show, by calling ShowBuilder.addSyntheticFeature(), and it can insert a new feature as the parent of a given feature, by calling ShowBuilder.injectParent(). It can also add segments and handlers by calling the appropriate builder methods.

When a parent is injected, the ShowBuilder calls postProcess() on all nodes automatically, including nodes that are created during the execution of postProcess() in another node.

Specified by:

postProcess in interface SENode

Parameters:

builder - The builder that holds state for the show

Throws:

java.io.IOException - if an error is encountered

See Also:

ShowBuilder.addSyntheticFeature(Feature), ShowBuilder.injectParent(Feature, Feature)

changeFeatureReference

public void changeFeatureReference(Feature from,
                                   Feature to)

Change a feature reference from one feature to a new one. If your node has a reference to the feature from, it should be changed to refer to to. This is called for every node in an SEShow when SENode.injectParent is used.

The ShowBuilder calls changeFeatureReference() on all nodes automatically, including nodes that are created during the execution of postProcess().

Specified by:

changeFeatureReference in interface SENode

See Also:

SENode.changeFeatureReference(Feature, Feature)

scaleBy

public void scaleBy(int xScale,
                    int yScale,
                    int xOffset,
                    int yOffset)

Scale this node by the given scale factor, and apply the given offset. This will change the size of the features and RC handlers within the show at compile time, so no special scaling action is required at runtime.

Specified by:

scaleBy in interface SEScalableNode

Parameters:

xScale - x scale factor in mills

yScale - y scale factor in mills

xOffset - x offset in pixels

yOffset - y offset in pixels

toString

public java.lang.String toString()

Overrides:

toString in class Feature

Returns:

a developer-friendly description of this feature, for debugging