|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.hdcookbook.grin.Show
com.hdcookbook.grin.SEShow
public class SEShow
Represents a show, with extra data that's useful for tools that run on SE (big JDK), including a record of things like the names of private features, and a list of all of the features and segments.
Field Summary |
---|
Fields inherited from class com.hdcookbook.grin.Show |
---|
component, features, fontName, fontStyleSize, initializer, publicFeatures, publicNamedCommands, publicRCHandlers, publicSegments, rcHandlers, segments, setupManager, showTop, showTopGroup, stickyImages |
Constructor Summary | |
---|---|
SEShow(Director director)
Create a new SEShow. |
Method Summary | |
---|---|
void |
accept(SEShowVisitor visitor)
Visit a SEShow with a SEShowVisitor. |
static void |
acceptCommand(SEShowVisitor visitor,
Command command)
Accept a command from a show. |
static void |
acceptCommands(SEShowVisitor visitor,
Command[] commands)
Visit a list of commands with a SEShowVisitor. |
static void |
acceptFeature(SEShowVisitor visitor,
Feature feature)
Accept a feature of a show. |
static void |
acceptFeatures(SEShowVisitor visitor,
Feature[] features)
Visit a list of features with a SEShowVisitor. |
static void |
acceptRCHandler(SEShowVisitor visitor,
RCHandler handler)
Accept an RC handler from a show. |
static void |
acceptRCHandlers(SEShowVisitor visitor,
RCHandler[] rcHandlers)
Visit a list of RC handlers with a SEShowVisitor. |
static void |
acceptSegments(SEShowVisitor visitor,
Segment[] segments)
Visit a list of segments with a SEShowVisitor. |
void |
appendCommandClassCode(java.lang.String s)
Append a declaration that will be emitted with the command class. |
void |
buildShow(Segment[] segments,
Feature[] features,
RCHandler[] rcHandlers,
java.lang.String[] stickyImages,
Segment showTop,
Group showTopGroup,
java.util.Hashtable publicSegments,
java.util.Hashtable publicFeatures,
java.util.Hashtable publicRCHandlers,
java.util.Hashtable publicNamedCommands,
java.lang.String[] fontName,
int[] fontStyleSize)
This is called to build the show. |
java.lang.String |
getBinaryGrinFileName()
Gets the name of the file that the GRIN compiler should generate. |
java.lang.String |
getCommandClassCode()
Get the extra code that goes in the command class |
Feature[] |
getFeatures()
Get all of the features in the show |
java.lang.String[] |
getFontName()
Get the font name array |
int[] |
getFontStyleSize()
Get they StyleSize information for the show's fonts |
BackgroundSpec[] |
getGrinviewBackgrounds()
|
MosaicSpec[] |
getMosaicSpecs()
Returns an array of MosaicSpec instances associated with this show, or an zero-length array if none is found. |
boolean |
getNoShowFile()
Get a flag to indicate that no binary show file should be generated. |
Segment |
getPrivateSegment(java.lang.String name)
Look up a private segment. |
java.util.Hashtable |
getPublicNamedCommands()
|
RCHandler[] |
getRCHandlers()
Get all of the remote control handlers in the show |
Segment[] |
getSegments()
Get all of the segments in the show |
SEShowCommands |
getShowCommands()
Get the object that represents the commands defined for this show. |
Group |
getShowTopGroup()
Get the group for active features of a show's currently activated segment. |
Segment |
getShowTopSegment()
Get the Show's top Segment, which represents the top of a rendering tree. |
java.lang.String[] |
getStickyImages()
Get the list of sticky images as a string array of the image file names. |
boolean |
isPublic(Feature f)
Determine if the given Feature is public |
boolean |
isPublic(RCHandler hand)
Determine if the given RCHandler is public |
boolean |
isPublic(Segment seg)
Determine if the given Segment is public |
boolean |
isPublic(SENode node)
Returns true if the node passed in is recorded as an public element in this show, false otherwise. |
MosaicSpec |
newMosaicSpec(java.lang.String name)
Called by the ShowParser when a new mosaic or mosaic_hint is found. |
void |
printContent(java.io.PrintStream out)
|
void |
scaleBy(int xScale,
int yScale,
int xOffset,
int yOffset)
Scale this show by the given scale factor, and apply the given offset. |
void |
setBinaryGrinFileName(java.lang.String name)
Sets the name of the file that the GRIN compiler should generate, if you want to override the default. |
void |
setGrinviewBackgrounds(java.util.ArrayList<BackgroundSpec> value)
Sets the list of background images for grinview. |
void |
setIsBinary(boolean isBinary)
Set a flag to indicate that this show file was read from a binary file. |
void |
setNamedCommands(Command[] namedCommands)
|
void |
setNoShowFile(boolean val)
Set a flag to indicate that no binary show file should be generated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SEShow(Director director)
director
- A Director helper class that can be used to
control the show.Method Detail |
---|
public void setIsBinary(boolean isBinary)
public void setNoShowFile(boolean val)
public boolean getNoShowFile()
public java.lang.String[] getStickyImages()
public Segment getShowTopSegment()
getShowTopGroup()
public Group getShowTopGroup()
getShowTopSegment()
public SEShowCommands getShowCommands()
public Segment[] getSegments()
public java.util.Hashtable getPublicNamedCommands()
public Feature[] getFeatures()
public RCHandler[] getRCHandlers()
public Segment getPrivateSegment(java.lang.String name)
public java.lang.String[] getFontName()
public int[] getFontStyleSize()
public boolean isPublic(Segment seg)
public boolean isPublic(Feature f)
public boolean isPublic(RCHandler hand)
public void setNamedCommands(Command[] namedCommands)
public void buildShow(Segment[] segments, Feature[] features, RCHandler[] rcHandlers, java.lang.String[] stickyImages, Segment showTop, Group showTopGroup, java.util.Hashtable publicSegments, java.util.Hashtable publicFeatures, java.util.Hashtable publicRCHandlers, java.util.Hashtable publicNamedCommands, java.lang.String[] fontName, int[] fontStyleSize) throws java.io.IOException
This adds internal structure checking to the superclass version of this method.
buildShow
in class Show
java.io.IOException
- if anything goes wrong.public void setBinaryGrinFileName(java.lang.String name)
name
- The file name, including any extensionpublic void setGrinviewBackgrounds(java.util.ArrayList<BackgroundSpec> value)
public BackgroundSpec[] getGrinviewBackgrounds()
public java.lang.String getBinaryGrinFileName()
public MosaicSpec newMosaicSpec(java.lang.String name) throws java.io.IOException
java.io.IOException
- if name is a duplicatepublic MosaicSpec[] getMosaicSpecs()
public void accept(SEShowVisitor visitor)
public static void acceptSegments(SEShowVisitor visitor, Segment[] segments)
public static void acceptFeatures(SEShowVisitor visitor, Feature[] features)
public static void acceptRCHandlers(SEShowVisitor visitor, RCHandler[] rcHandlers)
public static void acceptFeature(SEShowVisitor visitor, Feature feature)
public static void acceptRCHandler(SEShowVisitor visitor, RCHandler handler)
public static void acceptCommands(SEShowVisitor visitor, Command[] commands)
public static void acceptCommand(SEShowVisitor visitor, Command command)
public boolean isPublic(SENode node)
java.lang.RuntimeException
- if node is neither an instance of
Feature, RCHandler, nor Segment.public void printContent(java.io.PrintStream out)
public void scaleBy(int xScale, int yScale, int xOffset, int yOffset) throws java.io.IOException
xScale
- x scale factor in millsyScale
- y scale factor in millsxOffset
- x offset in pixelsyOffset
- y offset in pixels
java.io.IOException
public void appendCommandClassCode(java.lang.String s)
public java.lang.String getCommandClassCode()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |