configcontainer.html

JAVA多媒体开发类库说明

<A NAME="getViewingPlatforms()"><!-- --></A><H3>
getViewingPlatforms</H3>
<PRE>
public java.util.Set <B>getViewingPlatforms</B>()</PRE>
<DL>
<DD>Returns a read-only Set of all configured ViewingPlatform instances in
 the order they were defined in the configuration file.  The
 ConfigContainer class itself does not attach the ViewingPlatform
 instances to any scengraph components or universe Locales; they are not
 "live" until made so by a separate client such as ConfiguredUniverse.

 ViewingPlatform instances are created with the following command:<p>
 <blockquote>
 (NewViewPlatform <i>&lt;instance name&gt;</i>
 [Alias <i>&lt;alias name&gt;</i>])
 </blockquote>
 
 The ViewingPlatform is configured through the following command:<p>
 <blockquote>
 (ViewPlatformProperty <i>&lt;instance name&gt; &lt;property name&gt;
 &lt;property value&gt;</i>)
 </blockquote>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Set of all unique instances, or null</DL>
</DD>
</DL>
<HR>

<A NAME="getNamedViewingPlatforms()"><!-- --></A><H3>
getNamedViewingPlatforms</H3>
<PRE>
public java.util.Map <B>getNamedViewingPlatforms</B>()</PRE>
<DL>
<DD>Returns a read-only Map that maps ViewingPlatform names to instances.
 Names may be aliases and if so will map to the original instances.  The
 ConfigContainer class itself does not attach the ViewingPlatform
 instances to any scengraph components or universe Locales; they are not
 "live" until made so by a separate client such as ConfiguredUniverse.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Map from names to ViewingPlatform instances, or
  null if no instances</DL>
</DD>
</DL>
<HR>

<A NAME="getViewPlatformBehaviors()"><!-- --></A><H3>
getViewPlatformBehaviors</H3>
<PRE>
public java.util.Set <B>getViewPlatformBehaviors</B>()</PRE>
<DL>
<DD>Returns a read-only Set of all configured ViewPlatformBehavior
 instances in the order they were defined in the configuration file.<p>
 
 The behaviors are attached to any ViewingPlatforms that specified them;
 that is, the <code>setViewPlatformBehavior</code> and
 <code>setViewingPlatform</code> methods of ViewingPlatform and
 ViewPlatformBehavior have been called if appropriate.  However, a
 behavior's <code>initialize</code> method is not called until the
 ViewingPlatform to which it is attached is made live.<p>

 ViewPlatformBehavior instances are created by the following command:<p>
 <blockquote>
 (NewViewPlatformBehavior <i>&lt;instanceName&gt; &lt;className&gt;</i>)
 </blockquote>
 
 <i>className</i> must be the fully qualified name of a concrete class
 that extends the abstract ViewPlatformBehavior class.  The
 implementation must provide a parameterless constructor.<p>

 The behavior is configured using ViewPlatformBehaviorProperty:<p>
 <blockquote>
 (ViewPlatformBehaviorProperty <i>&lt;instanceName&gt;
  &lt;propertyName&gt; &lt;arg0&gt; ... &lt;argn&gt;</i>)
 </blockquote>
 
 ViewPlatformBehavior subclasses inherit a number of pre-defined
 properties that can be directly specified with the <i>propertyName</i>
 string; see the configuration file documentation for details.<p>

 Concrete ViewPlatformBehavior instances can also define their own
 unique properties.  In those cases, <i>propertyName</i> must be the
 name of a behavior method that takes an array of Objects as its only
 parameter; the array is populated with the values of <i>arg0</i>
 through <i>argn</i> when the method is invoked to set the property.
 These additional requirements for configurable behaviors can usually be
 fulfilled by extending or wrapping available ViewPlatformBehavior
 subclasses.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Set of all unique instances, or null</DL>
</DD>
</DL>
<HR>

<A NAME="getNamedViewPlatformBehaviors()"><!-- --></A><H3>
getNamedViewPlatformBehaviors</H3>
<PRE>
public java.util.Map <B>getNamedViewPlatformBehaviors</B>()</PRE>
<DL>
<DD>Returns a read-only Map that maps ViewPlatformBehavior names to
 instances.  Names may be aliases and if so will map to the original
 instances.<p>
 
 The behaviors are attached to any ViewingPlatforms that specified them;
 that is, the <code>setViewPlatformBehavior</code> and
 <code>setViewingPlatform</code> methods of ViewingPlatform and
 ViewPlatformBehavior have been called if appropriate.  However, a
 behavior's <code>initialize</code> method is not called until the
 ViewingPlatform to which it is attached is made live.<p>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Map from names to ViewPlatformBehavior instances, or
  null if no instances<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/j3d/utils/universe/ConfigContainer.html#getViewPlatformBehaviors()"><CODE>getViewPlatformBehaviors()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getNamedCanvases(java.lang.String)"><!-- --></A><H3>
getNamedCanvases</H3>
<PRE>
public java.util.Map <B>getNamedCanvases</B>(java.lang.String&nbsp;viewName)</PRE>
<DL>
<DD>Returns a read-only Map containing the named Canvas3D instances used by
 the specified Viewer.  Names may be aliases and if so will map to the
 original instances.  The set of unique Canvas3D instances used by a
 Viewer may be obtained by calling the Viewer's accessor methods
 directly.<p>
 
 A named Canvas3D is created and added to a Viewer whenever any of the
 following configuration commands are used:<p>
 <blockquote>
 (ViewProperty <i>&lt;view&gt;</i> Screen <i>&lt;screenName&gt;</i>)<br>
 (ViewProperty <i>&lt;view&gt;</i> Window <i>&lt;windowName&gt;</i>)
 </blockquote>
 
 <i>view</i> is the name of a Viewer created with the NewView command.
 The <i>screenName</i> and <i>windowName</i> parameters of the above
 commands are the keys to use when looking up the associated Canvas3D
 instances in the Map returned by this method.  <b>Note:</b> the
 NewScreen and NewWindow commands do <i>not</i> create Canvas3D
 instances themselves; they are created only by the above configuration
 commands.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>viewName</CODE> - the name of the Viewer
<DT><B>Returns:</B><DD>read-only Map containing the Viewer's named Canvas3D instances</DL>
</DD>
</DL>
<HR>

<A NAME="getGenericObjects()"><!-- --></A><H3>
getGenericObjects</H3>
<PRE>
public java.util.Set <B>getGenericObjects</B>()</PRE>
<DL>
<DD>Returns a read-only Set of all generic configuration object
 instances in the order they were defined in the configuration file.<p>

 Generic object instances are created with the following command:<p>
 <blockquote>
 (NewObject <i>&lt;instanceName&gt; &lt;className&gt;</i>)
 </blockquote>
 
 <i>className</i> must be the fully-qualified name of a class that
 provides a parameterless constructor.<p>

 The object is configured through the ObjectProperty command:<p>
 <blockquote>
 (ObjectProperty <i>&lt;instanceName&gt; &lt;propertyName&gt;
  &lt;arg0&gt; ... &lt;argn&gt;</i>)
 </blockquote>
 
 <i>propertyName</i> must be the name of a method provided by object
 <i>instanceName</i>.  It must take an array of Objects as its only
 parameter; the array is populated with the values of <i>arg0</i>
 through <i>argn</i> when the method is invoked to set the property.
 These additional requirements for configurable objects can usually be
 fulfilled by extending or wrapping available object classes.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Set of all unique instances, or null</DL>
</DD>
</DL>
<HR>

<A NAME="getNamedGenericObjects()"><!-- --></A><H3>
getNamedGenericObjects</H3>
<PRE>
public java.util.Map <B>getNamedGenericObjects</B>()</PRE>
<DL>
<DD>Returns a read-only Map that maps generic object names to
 instances.  Names may be aliases and if so will map to the original
 instances.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>read-only Map from names to generic object instances, or
  null if no instances<DT><B>See Also:</B><DD><A HREF="../../../../../com/sun/j3d/utils/universe/ConfigContainer.html#getGenericObjects()"><CODE>getGenericObjects()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getViewPlatformTransformCount()"><!-- --></A><H3>
getViewPlatformTransformCount</H3>
<PRE>
public int <B>getViewPlatformTransformCount</B>()</PRE>
<DL>
<DD>Returns the number of TransformGroups with which ViewingPlatforms
 should be created.  This is useful for clients that wish to provide a
 default ViewingPlatform if the configuration file doesn't specify one.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the number of TransformGroups</DL>
</DD>
</DL>
<HR>

<A NAME="getViewerVisibility()"><!-- --></A><H3>
getViewerVisibility</H3>
<PRE>
public boolean <B>getViewerVisibility</B>()</PRE>
<DL>
<DD>Returns whether Viewers should be created with their AWT components
 initially visible or invisible.  This is useful for clients that wish
 to provide a default Viewer if the configuration file doesn't specify
 one.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true if Viewer components should be initially visible; false
  otherwise</DL>
</DD>
</DL>
<HR>

<A NAME="clear()"><!-- --></A><H3>
clear</H3>
<PRE>
public void <B>clear</B>()</PRE>
<DL>
<DD>Release memory references used by this ConfigContainer.  All Sets and
 Maps obtained from this ConfigContainer are cleared.
<P>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="getConfigURL()"><!-- --></A><H3>
getConfigURL</H3>
<PRE>
public static java.net.URL <B>getConfigURL</B>()</PRE>
<DL>
<DD>Returns the config file URL based on system properties.  The current
 implementation of this method parses the j3d.configURL property as a
 URL string.  For example, the following command line would specify that
 the config file is taken from the file "j3dconfig" in the current
 directory:
 <ul>
 <code>java -Dj3d.configURL=file:j3dconfig ...</code>
 </ul>
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the URL of the config file; null is returned if no valid
  URL is defined by the system properties</DL>
</DD>
</DL>
<HR>

<A NAME="getConfigURL(java.lang.String)"><!-- --></A><H3>
getConfigURL</H3>
<PRE>
public static java.net.URL <B>getConfigURL</B>(java.lang.String&nbsp;defaultURLString)</PRE>
<DL>
<DD>Returns the config file URL based on system properties.  The current
 implementation of this method parses the j3d.configURL property as a
 URL string.  For example, the following command line would specify that
 the config file is taken from the file "j3dconfig" in the current
 directory:
 <ul>
 <code>java -Dj3d.configURL=file:j3dconfig ...</code>
 </ul>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>defaultURLString</CODE> - the default string used to construct
  the URL if the appropriate system properties are not defined
<DT><B>Returns:</B><DD>the URL of the config file; null is returned if no
  valid URL is defined either by the system properties or the
  default URL string</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>


<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  <TR ALIGN="center" VALIGN="top">
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../com/sun/j3d/utils/universe/ConfiguredUniverse.html" title="class in com.sun.j3d.utils.universe"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../../index.html?com/sun/j3d/utils/universe/ConfigContainer.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="ConfigContainer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>


</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
<font size="-1">Copyright (c) 2006 Sun Microsystems, Inc. All rights reserved. Use is subject to <a href="../../../../../LICENSE-SPEC.html">license terms</a>.
</BODY>
</HTML>