org.turro.help.HelpContext Class Reference

Static Public Member Functions
static String	helpLink (String current)
static String	helpLink (ElContext current)
static ElContext	help (String path)
static ElContext	help (ElContext current)
static boolean	exists (ElContext current)
static String	getHelpContextAttribute (String attribute, String defaultValue)

Detailed Description

Author

Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 38 of file HelpContext.java.

Member Function Documentation

exists()

static boolean org.turro.help.HelpContext.exists ( ElContext  current )

static

Definition at line 71 of file HelpContext.java.

                                                  {
    return help(current)!= null;
  }

Here is the call graph for this function:

getHelpContextAttribute()

static String org.turro.help.HelpContext.getHelpContextAttribute ( String  attribute, String  defaultValue  )

static

Definition at line 79 of file HelpContext.java.

                                                                                      {
    return ElephantProperties.getContextProperty(HELP_CONTEXT, attribute, defaultValue);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

help() [1/2]

static ElContext org.turro.help.HelpContext.help ( ElContext  current )

static

Definition at line 67 of file HelpContext.java.

                                                  {
    return current != null ? ElContextMap.getContext(getHelpContextAttribute("root", "/docs/contextual") + current.getPath()) : null;
  }

Here is the call graph for this function:

help() [2/2]

static ElContext org.turro.help.HelpContext.help ( String  path )

static

Definition at line 63 of file HelpContext.java.

                                            {
    return !Strings.isBlank(path) ? ElContextMap.getContext(getHelpContextAttribute("root", "/docs/contextual") + path) : null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

helpLink() [1/2]

static String org.turro.help.HelpContext.helpLink ( ElContext  current )

static

Definition at line 59 of file HelpContext.java.

                                                   {
    return current != null ? helpLink(current.getPath()) : null;
  }

Here is the call graph for this function:

helpLink() [2/2]

static String org.turro.help.HelpContext.helpLink ( String  current )

static

Definition at line 40 of file HelpContext.java.

                                                {
    ElContext ctx = help(current);
    if(ctx != null && ctx.getFile().exists()) {
      String webPath = ctx.getWebPath();
      if(webPath.startsWith("/")) { 
        try(DirectoryStream<Path> stream = Files.newDirectoryStream(Paths.get(ElephantContext.getRealPath(ctx.getPath())), "*.html")) {
          if(stream.iterator().hasNext()) {
            return webPath;
          }
        } catch (IOException ex) {
          Logger.getLogger(HelpContext.class.getName()).log(Level.SEVERE, ElephantContext.logMsg(current), ex);
        }
      } else {
        return webPath;
      }
    }
    return null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• HelpContext.java