ConfigSidebarHandler

java.lang.Object

net.i2p.router.web.FormHandler

net.i2p.router.web.helpers.ConfigSidebarHandler

public class ConfigSidebarHandlerextends FormHandler

Simple sidebar configuration handler.

Nested Class Summary
Nested classes/interfaces inherited from class FormHandler
FormHandler.Message
Modifier and Type
Class
Description
static class
FormHandler.Message
Message class to encapsulate the message text and the canClose flag.
Field Summary
Fields
Modifier and Type
Field
Description
private static final String
DELETE_PREFIX
Form field prefix of the section deletions.
private static final String
MOVE_PREFIX
Form field prefix of the section moves.
private static final String
ORDER_PREFIX
Form field prefix of the section ordering.
Fields inherited from class FormHandler
_action, _context, _log, _method, _out, _requestWrapper, _session, _settings
Modifier and Type
Field
Description
protected String
_action
Form action.
protected RouterContext
_context
Router context.
protected Log
_log
Class logger.
protected String
_method
Request method.
protected Writer
_out
Output writer.
protected RequestWrapper
_requestWrapper
Only for multipart/form-data.
protected HttpSession
_session
HTTP session for nonce validation.
protected Map
_settings
Not for multipart/form-data, will be null.
Constructor Summary
Constructors
Constructor
Description
ConfigSidebarHandler()
ConfigSidebarHandler default constructor.
Method Summary
Modifier and Type
Method
Description
private String
getJettyStringOrDefault(String key, String defaultVal)
Reads a Jetty config value.
private void
handleAddSection(Map<Integer,String> sections)
Adds a sidebar section from the form.
private void
handleDeleteSections(Map<Integer,String> sections)
Deletes the sections marked in the form.
private void
handleGraphSave()
Saves the sidebar graph settings.
private void
handleMoveSection(Map<Integer,String> sections)
Moves one sidebar section.
private void
handleSave(boolean currentUnifiedSidebar, boolean currentStickySidebar)
Saves the sidebar settings from the form.
void
moveSection(String action)
Moves, adds, deletes, or saves sidebar sections ordering based on the requested action.
private int
parseRefreshInterval(String refreshStr)
Parses the graph refresh interval from the form.
protected void
processForm()
Processes the form submission from the sidebar configuration page.
private void
restoreDefault(boolean full)
Restores the default sidebar settings.
void
setMovingAction()
Scans settings to detect move button actions and sets the _action field accordingly.
Methods inherited from class FormHandler
_t, _t, _t, _x, addFormError, addFormError, addFormErrorNoEscape, addFormErrorNoEscape, addFormNotice, addFormNotice, addFormNoticeNoEscape, addFormNoticeNoEscape, getAllMessages, getErrors, getJettyString, getNotices, isAdvanced, resolveEffectiveAction, setAction, setContextId, setNonce, setRequestWrapper, setSettings, storeMethod, storeSession, storeWriter
Modifier and Type
Method
Description
String
_t(String s)
Translate a string.
String
_t(String s, Object o)
Translate a string with a parameter This is a lot more expensive than _t(s), so use sparingly.
String
_t(String s, Object o, Object o2)
Translate a string with two parameters.
static String
_x(String s)
Mark a string for extraction by xgettext and translation.
protected void
addFormError(String errorMsg)
Add an error message to display Use if it does not include a link.
protected void
addFormError(String errorMsg, boolean canClose)
Add an error message to display Use if it does not include a link.
protected void
addFormErrorNoEscape(String msg)
Add an error message to display Use if it includes a link or other formatting.
protected void
addFormErrorNoEscape(String msg, boolean canClose)
Add an error message to display Use if it includes a link or other formatting.
protected void
addFormNotice(String msg)
Add a non-error message to display Use if it does not include a link.
protected void
addFormNotice(String msg, boolean canClose)
Add a non-error message to display Use if it does not include a link.
protected void
addFormNoticeNoEscape(String msg)
Add a non-error message to display Use if it includes a link or other formatting.
protected void
addFormNoticeNoEscape(String msg, boolean canClose)
Add a non-error message to display Use if it includes a link or other formatting.
String
getAllMessages()
Display everything, wrap it in a div for consistent presentation.
String
getErrors()
Display any error messages (processing the form if it hasn't been yet).
protected String
getJettyString(String key)
FormHandler.setSettings(Map) must have been called previously Curses Jetty for returning arrays.
String
getNotices()
Display any non-error messages (processing the form if it hasn't been yet).
boolean
isAdvanced()
Same as HelperBase.
static String
resolveEffectiveAction(String action, Map<?,?> settings)
Resolve which operation the user actually requested.
void
setAction(String val)
Action value.
void
setContextId(String contextId)
Configure this bean to query a particular router context.
void
setNonce(String val)
Nonce value.
void
setRequestWrapper(RequestWrapper rw)
Only set by formhandler.jsi for multipart/form-data.
void
setSettings(Map settings)
For many forms, it's easiest just to put all the parameters here.
void
storeMethod(String val)
Call this to prevent changes using GET.
void
storeSession(HttpSession session)
For nonce validation.
void
storeWriter(Writer out)
Store the output writer for inline form processing.
Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- ORDER_PREFIX
  private static final String ORDER_PREFIX
  Form field prefix of the section ordering.
  See Also:
  Constant Field Values
- DELETE_PREFIX
  private static final String DELETE_PREFIX
  Form field prefix of the section deletions.
  See Also:
  Constant Field Values
- MOVE_PREFIX
  private static final String MOVE_PREFIX
  Form field prefix of the section moves.
  See Also:
  Constant Field Values
Constructor Details
- ConfigSidebarHandler
  public ConfigSidebarHandler()
  ConfigSidebarHandler default constructor.
Method Details
- processForm
  protected void processForm()
  Processes the form submission from the sidebar configuration page. Handles add, delete, move, save order, and restore defaults actions. Delegates to helper methods as appropriate.
  Specified by:
  processForm in class FormHandler
- handleSave
  private void handleSave(boolean currentUnifiedSidebar, boolean currentStickySidebar)
  Saves the sidebar settings from the form.
  Parameters:
  currentUnifiedSidebar - true if the unified sidebar is on now
  currentStickySidebar - true if the sticky sidebar is on now
- handleGraphSave
  private void handleGraphSave()
  Saves the sidebar graph settings.
- parseRefreshInterval
  private int parseRefreshInterval(String refreshStr) throws NumberFormatException
  Parses the graph refresh interval from the form.
  Parameters:
  refreshStr - the string from the form
  Returns:
  the interval, in seconds
  Throws:
  NumberFormatException - if it is not a number
- getJettyStringOrDefault
  private String getJettyStringOrDefault(String key, String defaultVal)
  Reads a Jetty config value.
  Parameters:
  key - the config key
  defaultVal - the value to use if unset
  Returns:
  the value in use
- restoreDefault
  private void restoreDefault(boolean full)
  Restores the default sidebar settings.
  Parameters:
  full - true to restore the sections as well
- moveSection
  public void moveSection(String action)
  Moves, adds, deletes, or saves sidebar sections ordering based on the requested action. Updates the sidebar sections order and persists the changes.
  Parameters:
  action - the resolved fixed action value (additem, deleteitems, or move_N)
- handleAddSection
  private void handleAddSection(Map<Integer,String> sections)
  Adds a sidebar section from the form.
  Parameters:
  sections - the current sections, by position
- handleDeleteSections
  private void handleDeleteSections(Map<Integer,String> sections)
  Deletes the sections marked in the form.
  Parameters:
  sections - the current sections, by position
- handleMoveSection
  private void handleMoveSection(Map<Integer,String> sections)
  Moves one sidebar section.
  Parameters:
  sections - the current sections, by position
- setMovingAction
  public void setMovingAction()
  Scans settings to detect move button actions and sets the _action field accordingly.

Nested Class Summary

Nested classes/interfaces inherited from class FormHandler

Field Summary

Fields inherited from class FormHandler

Constructor Summary

Method Summary

Methods inherited from class FormHandler

Methods inherited from class Object

Field Details

ORDER_PREFIX

DELETE_PREFIX

MOVE_PREFIX

Constructor Details

Method Details

processForm

handleSave

handleGraphSave

parseRefreshInterval

getJettyStringOrDefault

restoreDefault

moveSection

handleAddSection

handleDeleteSections

handleMoveSection

setMovingAction