org.turro.elephant.web.context.WebContext Class Reference

Public Member Functions
boolean	isShowInNavigators ()
void	setShowInNavigators (boolean showInNavigators)
boolean	isShowAlways ()
void	setShowAlways (boolean showAlways)
boolean	isTraversalNavigation ()
void	setTraversalNavigation (boolean traversalNavigation)
boolean	isNoIndex ()
void	setNoIndex (boolean noIndex)
boolean	isNoFollow ()
void	setNoFollow (boolean noFollow)
boolean	isPrintContext ()
void	setPrintContext (boolean printContext)
boolean	isPrintVersion ()
void	setPrintVersion (boolean printVersion)
boolean	isControlVersion ()
void	setControlVersion (boolean controlVersion)
boolean	isIcon ()
void	setIcon (boolean icon)
Set< String >	getLangs ()
void	setLangs (Set< String > langs)
String	getName ()
Map< String, String >	getNames ()
void	setNames (Map< String, String > names)
String	getI18nKey ()
void	setI18nKey (String i18nKey)
String	getOrder ()
void	setOrder (String order)
String	getRole ()
void	setRole (String role)
String	getRedirect ()
void	setRedirect (String redirect)
String	getTarget ()
void	setTarget (String target)
String	getImage ()
void	setImage (String image)
String	getWebTag ()
void	setWebTag (String webTag)
WebLayout	getLayout ()
void	setLayout (WebLayout layout)
WebElement	getElement ()
void	setElement (WebElement element)
IElement	getElementInstance ()
WebPage	getPage ()
void	setPage (WebPage page)
String	getLangsStr ()
void	setLangsStr (String langs)
boolean	isWikiPage ()
boolean	isDynamic ()
void	setDynamic (boolean dynamic)

Static Public Member Functions
static WebContext	inheritFrom (WebContext webContext)
static String	relativeRepository ()
static Path	repository (Path path)
static boolean	existsConf (Path path)
static boolean	removeFrom (Path path)
static WebContext	loadFrom (Path path)
static void	saveTo (Path path, WebContext context)
static boolean	createFolders (Path relativePath)

Static Public Attributes
static final String	CONTEXT_FOLDER = "_internal"

Detailed Description

Author

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

Definition at line 44 of file WebContext.java.

Member Function Documentation

createFolders()

static boolean org.turro.elephant.web.context.WebContext.createFolders ( Path  relativePath )

static

Definition at line 350 of file WebContext.java.

                                                         {
    File folder = Path.of(ElephantContext.getRealPath("/"), relativePath.toString()).toFile();
    if(!folder.exists()) {
      folder.mkdir();
      folder.toPath().resolve(CONTEXT_FOLDER).resolve(CONTEXT_REPOSITORY).toFile().mkdirs();
      return true;
    } else {
      return false;
    }
  }

Here is the call graph for this function:

existsConf()

static boolean org.turro.elephant.web.context.WebContext.existsConf ( Path  path )

static

Definition at line 316 of file WebContext.java.

                                              {
    Path real = Path.of(ElephantContext.getRealPath(path.toString()), 
            CONTEXT_FOLDER, CONTEXT_FILE);
    return real.toFile().exists();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getElement()

WebElement org.turro.elephant.web.context.WebContext.getElement

(

)

Definition at line 230 of file WebContext.java.

                                 {
    return element;
  }

Here is the caller graph for this function:

getElementInstance()

IElement org.turro.elephant.web.context.WebContext.getElementInstance

(

)

Definition at line 238 of file WebContext.java.

                                       {
    return getElement().getInstance(this);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getI18nKey()

String org.turro.elephant.web.context.WebContext.getI18nKey

(

)

Definition at line 164 of file WebContext.java.

                             {
    return i18nKey;
  }

getImage()

String org.turro.elephant.web.context.WebContext.getImage

(

)

Definition at line 204 of file WebContext.java.

                           {
    return image;
  }

Here is the caller graph for this function:

getLangs()

Set<String> org.turro.elephant.web.context.WebContext.getLangs

(

)

Definition at line 136 of file WebContext.java.

                                {
    return langs;
  }

Here is the caller graph for this function:

getLangsStr()

String org.turro.elephant.web.context.WebContext.getLangsStr

(

)

Definition at line 254 of file WebContext.java.

                              {
    return Strings.listToCvs(getLangs());
  }

Here is the call graph for this function:

getLayout()

WebLayout org.turro.elephant.web.context.WebContext.getLayout

(

)

Definition at line 220 of file WebContext.java.

                               {
    return layout;
  }

Here is the caller graph for this function:

getName()

String org.turro.elephant.web.context.WebContext.getName

(

)

Definition at line 144 of file WebContext.java.

                          {
    if(!Strings.isBlank(i18nKey)) {
      return I_.get(i18nKey);
    }
    if(!getNames().isEmpty()) {
      return getNames().getOrDefault(
              "_" + I_.api().used().getLanguage(),
              getNames().values().iterator().next());
    }
    return null;
  }

Here is the call graph for this function:

Here is the caller graph for this function:

getNames()

Map<String, String> org.turro.elephant.web.context.WebContext.getNames

(

)

Definition at line 156 of file WebContext.java.

                                        {
    return names;
  }

Here is the caller graph for this function:

getOrder()

String org.turro.elephant.web.context.WebContext.getOrder

(

)

Definition at line 172 of file WebContext.java.

                           {
    return order;
  }

Here is the caller graph for this function:

getPage()

WebPage org.turro.elephant.web.context.WebContext.getPage

(

)

Definition at line 244 of file WebContext.java.

                           {
    return page;
  }

Here is the caller graph for this function:

getRedirect()

String org.turro.elephant.web.context.WebContext.getRedirect

(

)

Definition at line 188 of file WebContext.java.

                              {
    return redirect;
  }

Here is the caller graph for this function:

getRole()

String org.turro.elephant.web.context.WebContext.getRole

(

)

Definition at line 180 of file WebContext.java.

                          {
    return role;
  }

Here is the caller graph for this function:

getTarget()

String org.turro.elephant.web.context.WebContext.getTarget

(

)

Definition at line 196 of file WebContext.java.

                            {
    return target;
  }

Here is the caller graph for this function:

getWebTag()

String org.turro.elephant.web.context.WebContext.getWebTag

(

)

Definition at line 212 of file WebContext.java.

                            {
    return webTag;
  }

Here is the caller graph for this function:

inheritFrom()

static WebContext org.turro.elephant.web.context.WebContext.inheritFrom ( WebContext  webContext )

static

Definition at line 294 of file WebContext.java.

                                                              {
    WebContext wc = new WebContext();
    wc.setShowInNavigators(webContext.isShowInNavigators());
    wc.setPrintContext(webContext.isPrintContext());
    wc.setRole(webContext.getRole());
    wc.setOrder("000");
    wc.setNoIndex(webContext.isNoIndex());
    wc.setNoFollow(webContext.isNoFollow());
    wc.setPrintVersion(webContext.isPrintVersion());
    wc.setControlVersion(webContext.isControlVersion());
    wc.setTraversalNavigation(webContext.isTraversalNavigation());
    return wc;
  }

Here is the call graph for this function:

isControlVersion()

boolean org.turro.elephant.web.context.WebContext.isControlVersion

(

)

Definition at line 120 of file WebContext.java.

                                    {
    return controlVersion;
  }

Here is the caller graph for this function:

isDynamic()

boolean org.turro.elephant.web.context.WebContext.isDynamic

(

)

Definition at line 279 of file WebContext.java.

                             {
    return dynamic;
  }

isIcon()

boolean org.turro.elephant.web.context.WebContext.isIcon

(

)

Definition at line 128 of file WebContext.java.

                          {
    return icon;
  }

isNoFollow()

boolean org.turro.elephant.web.context.WebContext.isNoFollow

(

)

Definition at line 96 of file WebContext.java.

                              {
    return noFollow;
  }

Here is the caller graph for this function:

isNoIndex()

boolean org.turro.elephant.web.context.WebContext.isNoIndex

(

)

Definition at line 88 of file WebContext.java.

                             {
    return noIndex;
  }

Here is the caller graph for this function:

isPrintContext()

boolean org.turro.elephant.web.context.WebContext.isPrintContext

(

)

Definition at line 104 of file WebContext.java.

                                  {
    return printContext;
  }

Here is the caller graph for this function:

isPrintVersion()

boolean org.turro.elephant.web.context.WebContext.isPrintVersion

(

)

Definition at line 112 of file WebContext.java.

                                  {
    return printVersion;
  }

Here is the caller graph for this function:

isShowAlways()

boolean org.turro.elephant.web.context.WebContext.isShowAlways

(

)

Definition at line 72 of file WebContext.java.

                                {
    return showAlways;
  }

Here is the caller graph for this function:

isShowInNavigators()

boolean org.turro.elephant.web.context.WebContext.isShowInNavigators

(

)

Definition at line 64 of file WebContext.java.

                                      {
    return showInNavigators;
  }

Here is the caller graph for this function:

isTraversalNavigation()

boolean org.turro.elephant.web.context.WebContext.isTraversalNavigation

(

)

Definition at line 80 of file WebContext.java.

                                         {
    return traversalNavigation;
  }

Here is the caller graph for this function:

isWikiPage()

boolean org.turro.elephant.web.context.WebContext.isWikiPage

(

)

Definition at line 263 of file WebContext.java.

                              {
    return Strings.isBlank(redirect) && getElement().isEmpty();
  }

Here is the call graph for this function:

loadFrom()

static WebContext org.turro.elephant.web.context.WebContext.loadFrom ( Path  path )

static

Definition at line 328 of file WebContext.java.

                                               {
    Path real = Path.of(ElephantContext.getRealPath(path.toString()), 
            CONTEXT_FOLDER, CONTEXT_FILE);
    try(Reader reader = new FileReader(real.toFile())) {
      return JsonConfiguration.read(reader, WebContext.class);
    } catch (IOException ex) {
      Logger.getLogger(WebContext.class.getName()).log(Level.SEVERE, null, ex);
      return null;
    }
  }

Here is the call graph for this function:

relativeRepository()

static String org.turro.elephant.web.context.WebContext.relativeRepository ( )

static

Definition at line 308 of file WebContext.java.

                                            {
    return Path.of("/", CONTEXT_FOLDER, CONTEXT_REPOSITORY).toString();
  }

Here is the caller graph for this function:

removeFrom()

static boolean org.turro.elephant.web.context.WebContext.removeFrom ( Path  path )

static

Definition at line 322 of file WebContext.java.

                                              {
    Path real = Path.of(ElephantContext.getRealPath(path.toString()), 
            CONTEXT_FOLDER, CONTEXT_FILE);
    return real.toFile().delete();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

repository()

static Path org.turro.elephant.web.context.WebContext.repository ( Path  path )

static

Definition at line 312 of file WebContext.java.

                                           {
    return Path.of(path.toString(), relativeRepository());
  }

Here is the call graph for this function:

Here is the caller graph for this function:

saveTo()

static void org.turro.elephant.web.context.WebContext.saveTo ( Path  path, WebContext  context  )

static

Definition at line 339 of file WebContext.java.

                                                           {
    Path real = Path.of(ElephantContext.getRealPath(path.toString()), 
            CONTEXT_FOLDER, CONTEXT_FILE);
    try(Writer writer = new FileWriter(real.toFile())) {
      context.prepareSaving();
      JsonConfiguration.write(writer, context);
    } catch (IOException ex) {
      Logger.getLogger(WebContext.class.getName()).log(Level.SEVERE, null, ex);
    }
  }

Here is the call graph for this function:

setControlVersion()

void org.turro.elephant.web.context.WebContext.setControlVersion

(

boolean

controlVersion

)

Definition at line 124 of file WebContext.java.

                                                        {
    this.controlVersion = controlVersion;
  }

Here is the caller graph for this function:

setDynamic()

void org.turro.elephant.web.context.WebContext.setDynamic

(

boolean

dynamic

)

Definition at line 283 of file WebContext.java.

                                          {
    this.dynamic = dynamic;
  }

setElement()

void org.turro.elephant.web.context.WebContext.setElement

(

WebElement

element

)

Definition at line 234 of file WebContext.java.

                                             {
    this.element = element;
  }

setI18nKey()

void org.turro.elephant.web.context.WebContext.setI18nKey

(

String

i18nKey

)

Definition at line 168 of file WebContext.java.

                                         {
    this.i18nKey = i18nKey;
  }

setIcon()

void org.turro.elephant.web.context.WebContext.setIcon

(

boolean

icon

)

Definition at line 132 of file WebContext.java.

                                    {
    this.icon = icon;
  }

setImage()

void org.turro.elephant.web.context.WebContext.setImage

(

String

image

)

Definition at line 208 of file WebContext.java.

                                     {
    this.image = image;
  }

setLangs()

void org.turro.elephant.web.context.WebContext.setLangs

(

Set< String >

langs

)

Definition at line 140 of file WebContext.java.

                                          {
    this.langs = langs;
  }

setLangsStr()

void org.turro.elephant.web.context.WebContext.setLangsStr

(

String

langs

)

Definition at line 258 of file WebContext.java.

                                        {
    this.langs.clear();
    this.langs.addAll(Strings.csvToList(langs));
  }

setLayout()

void org.turro.elephant.web.context.WebContext.setLayout

(

WebLayout

layout

)

Definition at line 224 of file WebContext.java.

                                          {
    this.layout = layout;
  }

setNames()

void org.turro.elephant.web.context.WebContext.setNames

(

Map< String, String >

names

)

Definition at line 160 of file WebContext.java.

                                                  {
    this.names = names;
  }

setNoFollow()

void org.turro.elephant.web.context.WebContext.setNoFollow

(

boolean

noFollow

)

Definition at line 100 of file WebContext.java.

                                            {
    this.noFollow = noFollow;
  }

Here is the caller graph for this function:

setNoIndex()

void org.turro.elephant.web.context.WebContext.setNoIndex

(

boolean

noIndex

)

Definition at line 92 of file WebContext.java.

                                          {
    this.noIndex = noIndex;
  }

Here is the caller graph for this function:

setOrder()

void org.turro.elephant.web.context.WebContext.setOrder

(

String

order

)

Definition at line 176 of file WebContext.java.

                                     {
    this.order = order;
  }

Here is the caller graph for this function:

setPage()

void org.turro.elephant.web.context.WebContext.setPage

(

WebPage

page

)

Definition at line 248 of file WebContext.java.

                                    {
    this.page = page;
  }

setPrintContext()

void org.turro.elephant.web.context.WebContext.setPrintContext

(

boolean

printContext

)

Definition at line 108 of file WebContext.java.

                                                    {
    this.printContext = printContext;
  }

Here is the caller graph for this function:

setPrintVersion()

void org.turro.elephant.web.context.WebContext.setPrintVersion

(

boolean

printVersion

)

Definition at line 116 of file WebContext.java.

                                                    {
    this.printVersion = printVersion;
  }

Here is the caller graph for this function:

setRedirect()

void org.turro.elephant.web.context.WebContext.setRedirect

(

String

redirect

)

Definition at line 192 of file WebContext.java.

                                           {
    this.redirect = redirect;
  }

setRole()

void org.turro.elephant.web.context.WebContext.setRole

(

String

role

)

Definition at line 184 of file WebContext.java.

                                   {
    this.role = role;
  }

Here is the caller graph for this function:

setShowAlways()

void org.turro.elephant.web.context.WebContext.setShowAlways

(

boolean

showAlways

)

Definition at line 76 of file WebContext.java.

                                                {
    this.showAlways = showAlways;
  }

setShowInNavigators()

void org.turro.elephant.web.context.WebContext.setShowInNavigators

(

boolean

showInNavigators

)

Definition at line 68 of file WebContext.java.

                                                            {
    this.showInNavigators = showInNavigators;
  }

Here is the caller graph for this function:

setTarget()

void org.turro.elephant.web.context.WebContext.setTarget

(

String

target

)

Definition at line 200 of file WebContext.java.

                                       {
    this.target = target;
  }

setTraversalNavigation()

void org.turro.elephant.web.context.WebContext.setTraversalNavigation

(

boolean

traversalNavigation

)

Definition at line 84 of file WebContext.java.

                                                                  {
    this.traversalNavigation = traversalNavigation;
  }

Here is the caller graph for this function:

setWebTag()

void org.turro.elephant.web.context.WebContext.setWebTag

(

String

webTag

)

Definition at line 216 of file WebContext.java.

                                       {
    this.webTag = webTag;
  }

Member Data Documentation

CONTEXT_FOLDER

final String org.turro.elephant.web.context.WebContext.CONTEXT_FOLDER = "_internal"

static

Definition at line 290 of file WebContext.java.

---

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

• WebContext.java