Package com.simplicite.webapp
Class Navigator
- java.lang.Object
-
- com.simplicite.webapp.Navigator
-
- All Implemented Interfaces:
java.io.Serializable
public class Navigator extends java.lang.Object implements java.io.Serializable
Functional navigator.
Contains the full history and the current railway.
System parameter RAILWAY: max railway length, not limited if = 0, empty if lower than 0
System parameter SHOW_NAVIGATOR: "yes" to display the nav, "no" to hide- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
Navigator.HistoryItem
Navigation Itemclass
Navigator.Railway
Railway
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ADD
Add in the current railway, url parameter nav=addstatic java.lang.String
HIDE
Hide the railway, url parameter nav=hidestatic java.lang.String
HOME
Home pagestatic java.lang.String
NEW
Add in a new railway, url parameter nav=newstatic java.lang.String
NONE
Do not change the railwaystatic java.lang.String
RESET
Reset the railway, url parameter nav=reset
-
Constructor Summary
Constructors Constructor Description Navigator()
Contructor
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Navigator.HistoryItem
add(int type, ObjectDB object, boolean rowNav)
Add one object in the navigationNavigator.HistoryItem
add(java.lang.String url, java.lang.String display)
Add a URL to the navigationNavigator.HistoryItem
add(java.lang.String url, java.lang.String display, boolean rowNav)
Add a URL to the navigationboolean
back()
Backward the current positionvoid
clear()
Clear the navigation historyjava.lang.String
display(Grant g)
Display both current railway and history in a menu button.java.lang.String
getBackURL()
Get the backward URLjava.lang.String
getBackURL(boolean refreshMenu)
Deprecated.java.lang.String
getFormNavbar(HTMLPage page, ObjectDB obj, ObjectContextWeb ctx)
FORM Navbar between object rowsjava.util.List<Navigator.HistoryItem>
getHistory()
Get historyjava.lang.String
getHistoryMenu()
Navigation historystatic java.lang.String
getHistoryName(Grant g)
java.lang.String
getRailway()
Railway from the last List to opened formsint
getRailwayLength()
Get railway lengthjava.lang.String
getURL()
Get the current URLjava.lang.String
getURL(boolean refreshMenu)
Deprecated.java.lang.String
getURLForm(ObjectDB object)
java.lang.String
getURLList(ObjectDB object)
void
init(Grant g)
Prepare the navigatorboolean
isLoaded()
Is loaded?boolean
navigation(Agenda agenda, ObjectDB obj, ServletParameters params)
Agenda navigationboolean
navigation(ExternalObject ext, ServletParameters params)
External object navigationboolean
navigation(ObjectDB obj, Crosstab crosstab, ServletParameters params)
Crosstab navigationboolean
navigation(ObjectDB obj, Graphic graph, ServletParameters params)
Graph navigationvoid
navigation(ObjectDB obj, java.lang.String nav)
List navigation for business objectvoid
navigation(ObjectDB obj, java.lang.String nav, ObjectContextWeb ctx, boolean rowNav)
Form navigation for business objectboolean
navigation(PlaceMap placemap, ObjectDB obj, ServletParameters params)
Place map navigationboolean
navigation(Timesheet ts, ObjectDB obj, ServletParameters params, boolean isGantt)
Timesheet navigationboolean
navigation(View view, Grant g, ServletParameters params)
View navigationboolean
navigation(java.lang.String url, java.lang.String title, ServletParameters params)
Specific URL navigationvoid
remove(ObjectDB object)
Remove the FORM linkvoid
resetRailway()
Reset the railwayboolean
rowNavigation(java.lang.String action, ObjectDB obj, ObjectField rowId)
Record navigation for business object current listNavigator.HistoryItem
searchInHistory(java.lang.String url)
Search one URL in the historyvoid
serialize()
Serialize user historyvoid
setRailwayLength(int l)
Set railway lengthvoid
unserialize()
Unserialize user historyvoid
update(ObjectDB obj)
-
-
-
Field Detail
-
HOME
public static final java.lang.String HOME
Home page
-
NONE
public static final java.lang.String NONE
Do not change the railway- See Also:
- Constant Field Values
-
RESET
public static final java.lang.String RESET
Reset the railway, url parameter nav=reset- See Also:
- Constant Field Values
-
ADD
public static final java.lang.String ADD
Add in the current railway, url parameter nav=add- See Also:
- Constant Field Values
-
NEW
public static final java.lang.String NEW
Add in a new railway, url parameter nav=new- See Also:
- Constant Field Values
-
HIDE
public static final java.lang.String HIDE
Hide the railway, url parameter nav=hide- See Also:
- Constant Field Values
-
-
Method Detail
-
getHistory
public java.util.List<Navigator.HistoryItem> getHistory()
Get history- Returns:
- List of history items
-
getRailwayLength
public int getRailwayLength()
Get railway length- Returns:
- Railway length
-
setRailwayLength
public void setRailwayLength(int l)
Set railway length- Parameters:
l
- Railway length
-
isLoaded
public boolean isLoaded()
Is loaded?- Returns:
- True if loaded
-
init
public void init(Grant g)
Prepare the navigator- Parameters:
g
- User rights
-
add
public Navigator.HistoryItem add(java.lang.String url, java.lang.String display)
Add a URL to the navigation- Parameters:
url
- Any URL displayed in the work zonedisplay
- Label to display for this URL- Returns:
- The related new or existing item
-
add
public Navigator.HistoryItem add(java.lang.String url, java.lang.String display, boolean rowNav)
Add a URL to the navigation- Parameters:
url
- Any URL displayed in the work zonedisplay
- Label to display for this URLrowNav
- row navigation in a list ?- Returns:
- The related new or existing item
-
getURLForm
public java.lang.String getURLForm(ObjectDB object)
-
getURLList
public java.lang.String getURLList(ObjectDB object)
-
add
public Navigator.HistoryItem add(int type, ObjectDB object, boolean rowNav)
Add one object in the navigation- Parameters:
type
- NAV_FORM or NAV_LISTobject
- Business objectrowNav
- True if it'a row navigation in a list- Returns:
- the created item
-
searchInHistory
public Navigator.HistoryItem searchInHistory(java.lang.String url)
Search one URL in the history
-
remove
public void remove(ObjectDB object)
Remove the FORM link- Parameters:
object
- Deleted object
-
update
public void update(ObjectDB obj)
-
clear
public void clear()
Clear the navigation history
-
getHistoryName
public static java.lang.String getHistoryName(Grant g)
-
serialize
public void serialize()
Serialize user history
-
unserialize
public void unserialize()
Unserialize user history
-
resetRailway
public void resetRailway()
Reset the railway
-
back
public boolean back()
Backward the current position- Returns:
- True if succeed
-
getBackURL
@Deprecated public java.lang.String getBackURL(boolean refreshMenu)
Deprecated.
-
getBackURL
public java.lang.String getBackURL()
Get the backward URL
-
getURL
@Deprecated public java.lang.String getURL(boolean refreshMenu)
Deprecated.
-
getURL
public java.lang.String getURL()
Get the current URL
-
getRailway
public java.lang.String getRailway()
Railway from the last List to opened forms- Returns:
- HTML anchors
-
getHistoryMenu
public java.lang.String getHistoryMenu()
Navigation history- Returns:
- HTML menu button
-
display
public java.lang.String display(Grant g)
Display both current railway and history in a menu button. Check 2 system properties to define the railway length (RAILWAY) and to hide/show the navigator (SHOW_NAVIGATOR)- Returns:
- HTML div
-
rowNavigation
public boolean rowNavigation(java.lang.String action, ObjectDB obj, ObjectField rowId)
Record navigation for business object current list- Parameters:
action
- First, back, next, lastobj
- Business objectrowId
- Current row ID- Returns:
- True if row navigation found
-
navigation
public void navigation(ObjectDB obj, java.lang.String nav, ObjectContextWeb ctx, boolean rowNav)
Form navigation for business object- Parameters:
obj
- Business objectnav
- Nav parameterctx
- Object contextrowNav
- True if it's a row navigation
-
navigation
public void navigation(ObjectDB obj, java.lang.String nav)
List navigation for business object- Parameters:
obj
- Business objectnav
- Navigation parameter
-
navigation
public boolean navigation(ExternalObject ext, ServletParameters params)
External object navigation- Parameters:
ext
- External objectparams
- Request parameters
-
navigation
public boolean navigation(Agenda agenda, ObjectDB obj, ServletParameters params)
Agenda navigation- Parameters:
agenda
- Agendaobj
- Business objectparams
- Request parameters
-
navigation
public boolean navigation(PlaceMap placemap, ObjectDB obj, ServletParameters params)
Place map navigation- Parameters:
placemap
- Place mapobj
- Business objectparams
- Request parameters
-
navigation
public boolean navigation(Timesheet ts, ObjectDB obj, ServletParameters params, boolean isGantt)
Timesheet navigation- Parameters:
ts
- Timesheetobj
- Business objectparams
- HTTP request parametersisGantt
- GANTT chart ?
-
navigation
public boolean navigation(View view, Grant g, ServletParameters params)
View navigation- Parameters:
view
- Viewg
- Grantparams
- HTTP request parameters
-
navigation
public boolean navigation(ObjectDB obj, Crosstab crosstab, ServletParameters params)
Crosstab navigation- Parameters:
obj
- Objectcrosstab
- Cross tableparams
- HTTP request parameters
-
navigation
public boolean navigation(ObjectDB obj, Graphic graph, ServletParameters params)
Graph navigation- Parameters:
obj
- Objectgraph
- Graphparams
- HTTP request parameters
-
navigation
public boolean navigation(java.lang.String url, java.lang.String title, ServletParameters params)
Specific URL navigation- Parameters:
url
- URLtitle
- Titleparams
- HTTP request parameters
-
getFormNavbar
public java.lang.String getFormNavbar(HTMLPage page, ObjectDB obj, ObjectContextWeb ctx)
FORM Navbar between object rows
-
-