程序包 org.apache.velocity.tools.view

类 IncludeTool

java.lang.Object
org.apache.velocity.tools.generic.SafeConfig
org.apache.velocity.tools.view.IncludeTool
所有已实现的接口:
Serializable
@DefaultKey("include") @InvalidScope("application") public class IncludeTool extends SafeConfig implements Serializable
Allows for transparent content negotiation in a manner mimicking Apache httpd's MultiViews.

Reads the default language out of the ViewToolContext as org.apache.velocity.tools.view.i18n.defaultLanguage. See find(String, String), find(String, Locale) and exists(String) for usage.

This is the successor to the MultiViewsTool in VelocityTools 1.x. Please note that it does NOT do the actual #include or #parse for you, but is merely to aid in include content negotiation.

从以下版本开始:
VelocityTools 2.0
版本:
$Id$
作者:
Daniel Rall, Nathan Bubna
另请参阅:

  • 字段详细资料

    • DEFAULT_LANGUAGE_KEY

      protected static final String DEFAULT_LANGUAGE_KEY
      The key used to search initialization, context, and JVM parameters for the default language to use.
      另请参阅:

    • defaultLanguage

      protected String defaultLanguage
      The two character abbreviation for the request's default language.

    • engine

      protected org.apache.velocity.app.VelocityEngine engine

  • 构造器详细资料

    • IncludeTool

      public IncludeTool()

  • 方法详细资料

    • configure

      protected void configure(ValueParser params)
      Extracts the default language from the specified ViewContext, looking first at the Velocity context, then the servlet context, then lastly at the JVM default. This "narrow scope to wide scope" pattern makes it easy to setup language overrides at different levels within your application.
      覆盖:
      configure 在类中 SafeConfig
      参数:
      params - the Map of configuration parameters
      抛出:
      IllegalArgumentException - if the param is not a ViewContext

    • configure

      protected void configure(ViewToolContext ctx)

    • find

      public String find(String name, Locale locale)
      Calls find(String, String) using the language extracted from locale.
      参数:
      name - resource filename
      locale - locale
      返回:
      locallized resource filename
      另请参阅:

    • find

      public String find(String name)
      Calls find(String, String) using the default language.
      参数:
      name - resource filename
      返回:
      locallized resource filename
      另请参阅:

    • find

      public String find(String name, String language)

      Finds the a localized version of the requested Velocity resource (such as a file or template) which is most appropriate for the locale of the current request. Use in conjuction with Apache httpd's MultiViews, or by itself.

      Usage from a template would be something like the following:

      
 #parse( $include.find('header.vm', 'en') )
 #include( $include.find('my_page.html', 'en') )
 #parse( $include.find('footer.vm', 'en') )

      You might also wrap this method using another pull/view tool which does internationalization/localization/content negation for a single point of access.

      参数:
      name - The unlocalized name of the file to find.
      language - The language to find localized context for.
      返回:
      The localized file name, or name if it is not localizable.

    • exists

      public boolean exists(String name)

      Checks to see whether a #parse-able template or #include-able resource exists under the specified name/path.

      Usage from a template would be something like the following:

       #if( $include.exists('header.vm') )
   #parse( 'header.vm' )
 #end
      参数:
      name - resource filename
      返回:
      whether resource exists
      另请参阅:
      • VelocityEngine.resourceExists(java.lang.String)

    • exists

      public boolean exists(String name, String language)
      Checks to see whether a localized version of the named template exists for the specified language.
      参数:
      name - resource filename
      language - asked language
      返回:
      whether resource exists
      另请参阅: