| java.lang.Object
 com.salmonllc.html.HtmlComponent
com.salmonllc.html.HtmlContainer
com.salmonllc.gui.NavigationMenu
| NavigationMenu | | public class NavigationMenu extends HtmlContainer (Code) | | Creates a navigation menu for a web site
|
| Method Summary | |
| public void | add(HtmlComponent comp)
| | public NavigationGroupInterface | addGroup(String image, int vertPadding)
| | public int | addMenuItem(int menu, String title, String href, String target, int horizPadding)
| | public int | addMenuItem(int menu, String title, String href, String target, int horizPadding, boolean createTable)
| | public int | addMenuItem(int menu, String submenu, String title, String href, String target, int horizPadding)
Adds a menu item to Navigation Menu
Parameters:
menu - int Index of the group menu to add to.
Parameters:
submenu - java.lang.String submenu name of the item added. | | public int | addMenuItem(int menu, String submenu, String title, String href, String target, int horizPadding, boolean createTable)
Adds a menu item to Navigation Menu
Parameters:
menu - int Index of the group menu to add to.
Parameters:
submenu - java.lang.String submenu name of the item added. | | public void | clearSelectedItem()
This method clears the selected menu item. | | public int | createMenu(String image, int vertPadding)
Creates a group menu in the Navigation Menu. | | public int | createMenu(String image, int vertPadding, boolean createTable)
Creates a group menu in the Navigation Menu. | | public boolean | getDisableCellLink()
Returns whether the cell of the Navigation Menu can act as a link. | | public NavigationGroupInterface[] | getGroups()
Returns an array Group Objects representing the Groups in the Navigation Menu. | | public Vector | getPopups()
Returns a vector of com.salmonllc.html.HtmlPopups belonging to this navigation menu. | | public NavigationMenu | getSubMenu(int groupIndex, int itemIndex)
Returns a Navigation Menu representing a submenu. | | public NavigationGroupInterface | insertGroupAt(String image, int vertPadding, int iLocation)
| | public NavigationGroupInterface | insertGroupAt(String image, int vertPadding, NavigationGroupInterface ngiInsertBefore)
| | public int | insertMenuItemAt(int menu, String title, String href, String target, int horizPadding, int iLocation)
| | public int | insertMenuItemAt(int menu, String title, String href, String target, int horizPadding, boolean createTable, int iLocation)
| | public int | insertMenuItemAt(int menu, String submenu, String title, String href, String target, int horizPadding, int iLocation)
Inserts a menu item into Navigation Menu at specified location
Parameters:
menu - int Index of the group menu to add to.
Parameters:
submenu - java.lang.String submenu name of the item added. | | public int | insertMenuItemAt(int menu, String submenu, String title, String href, String target, int horizPadding, boolean createTable, int iLocation)
Inserts a menu item into Navigation Menu at specified location
Parameters:
menu - int Index of the group menu to add to.
Parameters:
submenu - java.lang.String submenu name of the item added. | | protected HtmlContainer | newEntry(String href, String target, String caption, String unique)
Constructs an HtmlLink component containing a text caption. | | protected HtmlContainer | newEntry(String href, String target, String caption, String unique, int iHorSpacer)
Constructs an HtmlLink component containing a text caption. | | protected HtmlContainer | newEntry(String submenu, String href, String target, String caption, String unique)
Constructs an HtmlLink component containing a text caption. | | protected HtmlContainer | newEntry(String submenu, String href, String target, String caption, String unique, int iHorSpacer)
Constructs an HtmlLink component containing a text caption. | | protected HtmlImage | newHorizontalSpacer(int pixels)
| | public HtmlStyle | newStyle(String name, String type, String styleprop)
Creates a HtmlStyle object with the given name,type & property string containing the style information
com.salmonllc.html.HtmlStyle
Parameters:
name - java.lang.String The name to be given to the style so that it can be reference in HTML
Parameters:
type - java.lang.String The type of style to generate e.g. | | protected HtmlImage | newVerticalSpacer(int pixels)
| | public void | refresh()
Causes the Navigation Menu to be regenerated. | | public void | removePopups()
Removes the HtmlPopups from the NavigationMenu. | | public void | setDisableCellLink(boolean bDisable)
Specifies whether to disable/enable the cell in a Navigation Menu to be a link or not. | | public void | setEnableLayer(boolean enable)
Specifies whether the Navigation Menu is to be in its own layer. | | public void | setGroup(String groupname)
Specifies the Group Name in the Properties File for the Navigation Menu to be built from. | | public void | setHref(int groupIndex, int itemIndex, String href)
Changes the Href of an item in the Navigation Menu. | | public void | setSelectedItem()
This selects the current page shown if it has a reference in the menu. | | public void | setSelectedItem(int groupIndex, int itemIndex)
Specify which item in the Navigation Menu is to be highlighted as selected.. | | public void | setSelectedItem(String pageName)
This selects the item via pagename if it exists in the menu. | | public void | setSizeOption(int sizeoption)
Specifies how the Navigation Menu is to be sized, via percatage or pixels. | | public void | setTarget(int groupIndex, int itemIndex, String target)
Sets the target window for the link of an item in the Navigation Menu. | | public void | setTitle(int groupIndex, int itemIndex, String title)
Sets the title displayed of an item in the Navigation Menu. | | public void | setVisible(int groupIndex, int itemIndex, boolean visible)
Sets whether the item is visible or not. | | public void | setVisible(int groupIndex, boolean visible)
Sets whether the group is visible or not. | | public void | setVisible(String pageName, boolean visible)
This hides/shows the item via pagename if it exists in the menu. | | public void | setWidth(int width)
Sets the width of the Navigation Menu. |
| _NavTableBackgroundColor | | String _NavTableBackgroundColor(Code) | | |
| _NavTableBorder_NavTableCellSpacing_NavTableCellPadding_NavTableLayerWidth_NavTableLayerHeight_NavTableLayerTop_NavTableLayerLeft | | int _NavTableBorder_NavTableCellSpacing_NavTableCellPadding_NavTableLayerWidth_NavTableLayerHeight_NavTableLayerTop_NavTableLayerLeft(Code) | | |
| _disableCellLink | | boolean _disableCellLink(Code) | | |
| _enableLayer | | boolean _enableLayer(Code) | | |
| _layerwidth | | int _layerwidth(Code) | | |
| _linkfontstyle_linkfonthoverstyle_selectedFontStyle_selectedFontHoverStyle | | HtmlStyle _linkfontstyle_linkfonthoverstyle_selectedFontStyle_selectedFontHoverStyle(Code) | | |
| _linkstyle_linkhoverstyle_linkcellhoverstyle_cellStyle_cellHoverStyle_selectedCellStyle_selectedStyle_selectedHoverStyle_selectedCellHoverStyle_fontStyle | | HtmlStyle _linkstyle_linkhoverstyle_linkcellhoverstyle_cellStyle_cellHoverStyle_selectedCellStyle_selectedStyle_selectedHoverStyle_selectedCellHoverStyle_fontStyle(Code) | | |
| _selectedGroupIndex | | int _selectedGroupIndex(Code) | | |
| _selectedItemIndex | | int _selectedItemIndex(Code) | | |
| _selectedItemMarkerImg_selectedItemMarkerMouseOverImg_itemMarkerImg_itemTitleMarkerImg_itemMarkerMouserOverImg | | String _selectedItemMarkerImg_selectedItemMarkerMouseOverImg_itemMarkerImg_itemTitleMarkerImg_itemMarkerMouserOverImg(Code) | | |
| _sizeOption | | int _sizeOption(Code) | | |
| NavigationMenu | | public NavigationMenu(HtmlPage p) throws Exception(Code) | | NavigationMenu Constructor.
Parameters:
name - java.lang.String
Parameters:
p - com.salmonllc.html.HtmlPage
Parameters:
groupname - java.lang.String Name of group in properties files for generating menu. |
| NavigationMenu | | public NavigationMenu(String name, HtmlPage p) throws Exception(Code) | | This constructor creates a NavigationMenu using properties from a group with a groupname of default.
Parameters:
name - java.lang.String
Parameters:
p - com.salmonllc.html.HtmlPage |
| NavigationMenu | | public NavigationMenu(String name, HtmlPage p, String groupname) throws Exception(Code) | | NavigationMenu Constructor.
Parameters:
name - java.lang.String
Parameters:
p - com.salmonllc.html.HtmlPage
Parameters:
groupname - java.lang.String Name of group in properties files for generating menu. |
| NavigationMenu | | public NavigationMenu(String name, HtmlPage p, String groupname, String parentgroup) throws Exception(Code) | | NavigationMenu Constructor.
Parameters:
name - java.lang.String
Parameters:
p - com.salmonllc.html.HtmlPage
Parameters:
groupname - java.lang.String Name of group in properties files for generating menu. |
| NavigationMenu | | public NavigationMenu(String name, HtmlPage p, String groupname, boolean bSubmenu) throws Exception(Code) | | NavigationMenu Constructor.
Parameters:
name - java.lang.String
Parameters:
p - com.salmonllc.html.HtmlPage
Parameters:
groupname - java.lang.String Name of group in properties files for generating menu. |
| add | | public void add(HtmlComponent comp)(Code) | | Adds a new html component to the container
Parameters:
comp - com.salmonllc.html.HtmlComponent |
| addGroup | | public NavigationGroupInterface addGroup(String image, int vertPadding)(Code) | | Adds a group to the NavigationMenu
Parameters:
image - java.lang.String Filename of the Image
Parameters:
vertPadding - int The number of pixels providing vertical padding for the group |
| addMenuItem | | public int addMenuItem(int menu, String title, String href, String target, int horizPadding) throws Exception(Code) | | Adds a menu item to Navigation Menu
Parameters:
menu - int Index of the group menu to add to.
Parameters:
title - java.lang.String title displayed of the item added
Parameters:
href - java.lang.String href link of the item added
Parameters:
target - java.lang.String target window of the href link
Parameters:
horizPadding - int The number of pixels to pad the item by. |
| addMenuItem | | public int addMenuItem(int menu, String title, String href, String target, int horizPadding, boolean createTable) throws Exception(Code) | | Adds a menu item to Navigation Menu
Parameters:
menu - int Index of the group menu to add to.
Parameters:
title - java.lang.String title displayed of the item added
Parameters:
href - java.lang.String href link of the item added
Parameters:
target - java.lang.String target window of the href link
Parameters:
horizPadding - int The number of pixels to pad the item by.
Parameters:
createTable - boolean Indicates whether to regenerate the html for the navigation menu. |
| addMenuItem | | public int addMenuItem(int menu, String submenu, String title, String href, String target, int horizPadding) throws Exception(Code) | | Adds a menu item to Navigation Menu
Parameters:
menu - int Index of the group menu to add to.
Parameters:
submenu - java.lang.String submenu name of the item added. Indicates item is a submenu.
Parameters:
title - java.lang.String title displayed of the item added
Parameters:
href - java.lang.String href link of the item added
Parameters:
target - java.lang.String target window of the href link
Parameters:
horizPadding - int The number of pixels to pad the item by. |
| addMenuItem | | public int addMenuItem(int menu, String submenu, String title, String href, String target, int horizPadding, boolean createTable) throws Exception(Code) | | Adds a menu item to Navigation Menu
Parameters:
menu - int Index of the group menu to add to.
Parameters:
submenu - java.lang.String submenu name of the item added. Indicates item is a submenu.
Parameters:
title - java.lang.String title displayed of the item added
Parameters:
href - java.lang.String href link of the item added
Parameters:
target - java.lang.String target window of the href link
Parameters:
horizPadding - int The number of pixels to pad the item by.
Parameters:
createTable - boolean Indicates whether to regenerate the html for the navigation menu. |
| clearSelectedItem | | public void clearSelectedItem()(Code) | | This method clears the selected menu item.
|
| createMenu | | public int createMenu(String image, int vertPadding) throws Exception(Code) | | Creates a group menu in the Navigation Menu.
Parameters:
image - java.lang.String The filename of the image to represent the group
Parameters:
vertPadding - int The vertical padding for the group |
| createMenu | | public int createMenu(String image, int vertPadding, boolean createTable) throws Exception(Code) | | Creates a group menu in the Navigation Menu.
Parameters:
image - java.lang.String The filename of the image to represent the group
Parameters:
vertPadding - int The vertical padding for the group
Parameters:
createTable - boolean Indicates whether to regenerate the html for the navigation menu. |
| getDisableCellLink | | public boolean getDisableCellLink()(Code) | | Returns whether the cell of the Navigation Menu can act as a link.
boolean Indicates whether cells in the Navigation Menu act as links. |
| getGroups | | public NavigationGroupInterface[] getGroups()(Code) | | Returns an array Group Objects representing the Groups in the Navigation Menu.
NavigationGroupInterface[] Array of groups in NavigationMenu. |
| getPopups | | public Vector getPopups()(Code) | | Returns a vector of com.salmonllc.html.HtmlPopups belonging to this navigation menu.
Creation date: (8/16/01 4:01:16 PM)
java.util.Vector Vector of com.salmonllc.html.HtmlPopups |
| getSubMenu | | public NavigationMenu getSubMenu(int groupIndex, int itemIndex)(Code) | | Returns a Navigation Menu representing a submenu.
Parameters:
groupIndex - is the group index of the submenu entry.
Parameters:
itemIndex - is the item index of the submenu entry. |
| insertGroupAt | | public NavigationGroupInterface insertGroupAt(String image, int vertPadding, int iLocation)(Code) | | Inserts a group into the NavigationMenu at specified location
Parameters:
image - java.lang.String Filename of the Image
Parameters:
vertPadding - int The number of pixels providing vertical padding for the group
Parameters:
iLocation - int The index at which to Insert the Group |
| insertGroupAt | | public NavigationGroupInterface insertGroupAt(String image, int vertPadding, NavigationGroupInterface ngiInsertBefore)(Code) | | Inserts a group into the NavigationMenu at specified location
Parameters:
image - java.lang.String Filename of the Image
Parameters:
vertPadding - int The number of pixels providing vertical padding for the group
Parameters:
ngiInsertBefore - NavigationGroupInterface The group at which to Insert the Group before. |
| insertMenuItemAt | | public int insertMenuItemAt(int menu, String title, String href, String target, int horizPadding, int iLocation) throws Exception(Code) | | Inserts a menu item into Navigation Menu at specified location
Parameters:
menu - int Index of the group menu to add to.
Parameters:
title - java.lang.String title displayed of the item added
Parameters:
href - java.lang.String href link of the item added
Parameters:
target - java.lang.String target window of the href link
Parameters:
horizPadding - int The number of pixels to pad the item by.
Parameters:
iLocation - int The index at which to Insert the Item |
| insertMenuItemAt | | public int insertMenuItemAt(int menu, String title, String href, String target, int horizPadding, boolean createTable, int iLocation) throws Exception(Code) | | Inserts a menu item into Navigation Menu at specified location
Parameters:
menu - int Index of the group menu to add to.
Parameters:
title - java.lang.String title displayed of the item added
Parameters:
href - java.lang.String href link of the item added
Parameters:
target - java.lang.String target window of the href link
Parameters:
horizPadding - int The number of pixels to pad the item by.
Parameters:
createTable - boolean Indicates whether to regenerate the html for the navigation menu.
Parameters:
iLocation - int The index at which to Insert the Item |
| insertMenuItemAt | | public int insertMenuItemAt(int menu, String submenu, String title, String href, String target, int horizPadding, int iLocation) throws Exception(Code) | | Inserts a menu item into Navigation Menu at specified location
Parameters:
menu - int Index of the group menu to add to.
Parameters:
submenu - java.lang.String submenu name of the item added. Indicates item is a submenu.
Parameters:
title - java.lang.String title displayed of the item added
Parameters:
href - java.lang.String href link of the item added
Parameters:
target - java.lang.String target window of the href link
Parameters:
horizPadding - int The number of pixels to pad the item by.
Parameters:
iLocation - int The index at which to Insert the Item |
| insertMenuItemAt | | public int insertMenuItemAt(int menu, String submenu, String title, String href, String target, int horizPadding, boolean createTable, int iLocation) throws Exception(Code) | | Inserts a menu item into Navigation Menu at specified location
Parameters:
menu - int Index of the group menu to add to.
Parameters:
submenu - java.lang.String submenu name of the item added. Indicates item is a submenu.
Parameters:
title - java.lang.String title displayed of the item added
Parameters:
href - java.lang.String href link of the item added
Parameters:
target - java.lang.String target window of the href link
Parameters:
horizPadding - int The number of pixels to pad the item by.
Parameters:
createTable - boolean Indicates whether to regenerate the html for the navigation menu.
Parameters:
iLocation - int The index at which to Insert the Item |
| newEntry | | protected HtmlContainer newEntry(String href, String target, String caption, String unique) throws Exception(Code) | | Constructs an HtmlLink component containing a text caption.
HtmlContainer
Parameters:
href - The URL for the link.
Parameters:
target - The target associated with the link.
Parameters:
caption - The text caption for the link.
Parameters:
unique - A unique string to identify different entries in HTML for naming purposes. |
| newEntry | | protected HtmlContainer newEntry(String href, String target, String caption, String unique, int iHorSpacer) throws Exception(Code) | | Constructs an HtmlLink component containing a text caption.
HtmlContainer
Parameters:
href - The URL for the link.
Parameters:
target - The target associated with the link.
Parameters:
caption - The text caption for the link.
Parameters:
unique - A unique string to identify different entries in HTML for naming purposes.
Parameters:
iHorSpacer - The horizontal tabing of an entry. |
| newEntry | | protected HtmlContainer newEntry(String submenu, String href, String target, String caption, String unique) throws Exception(Code) | | Constructs an HtmlLink component containing a text caption.
HtmlContainer
Parameters:
submenu - The Name of another group for SubMenu.
Parameters:
caption - The text caption for the link.
Parameters:
unique - A unique string to identify different entries in HTML for naming purposes. |
| newEntry | | protected HtmlContainer newEntry(String submenu, String href, String target, String caption, String unique, int iHorSpacer) throws Exception(Code) | | Constructs an HtmlLink component containing a text caption.
HtmlContainer
Parameters:
submenu - The Name of another group for SubMenu.
Parameters:
caption - The text caption for the link.
Parameters:
unique - A unique string to identify different entries in HTML for naming purposes. |
| newHorizontalSpacer | | protected HtmlImage newHorizontalSpacer(int pixels)(Code) | | |
| newStyle | | public HtmlStyle newStyle(String name, String type, String styleprop)(Code) | | Creates a HtmlStyle object with the given name,type & property string containing the style information
com.salmonllc.html.HtmlStyle
Parameters:
name - java.lang.String The name to be given to the style so that it can be reference in HTML
Parameters:
type - java.lang.String The type of style to generate e.g. A an anchor style, TD a table cell style etc.
Parameters:
styleprop - java.lang.String References a property in the properties file giving the style information for the HtmlStyle |
| refresh | | public void refresh() throws Exception(Code) | | Causes the Navigation Menu to be regenerated.
|
| removePopups | | public void removePopups()(Code) | | Removes the HtmlPopups from the NavigationMenu.
Creation date: (8/17/01 6:08:43 PM)
|
| setDisableCellLink | | public void setDisableCellLink(boolean bDisable)(Code) | | Specifies whether to disable/enable the cell in a Navigation Menu to be a link or not.
Parameters:
bDisable - boolean Indicates to whether to disable/enable the link ability of cells within this Navigation Menu. |
| setEnableLayer | | public void setEnableLayer(boolean enable) throws Exception(Code) | | Specifies whether the Navigation Menu is to be in its own layer.
Parameters:
enable - boolean Indicate whether the Navigation Menu is to be in its own layer |
| setGroup | | public void setGroup(String groupname) throws Exception(Code) | | Specifies the Group Name in the Properties File for the Navigation Menu to be built from.
Parameters:
groupname - the name of the group in the properties file describing the menu. |
| setHref | | public void setHref(int groupIndex, int itemIndex, String href)(Code) | | Changes the Href of an item in the Navigation Menu.
Parameters:
groupIndex - is the group index of the entry to change the HRef of.
Parameters:
itemIndex - is the item index of the entry to change the HRef of.
Parameters:
href - is the new URL for the HREF of the link. |
| setSelectedItem | | public void setSelectedItem()(Code) | | This selects the current page shown if it has a reference in the menu.
|
| setSelectedItem | | public void setSelectedItem(int groupIndex, int itemIndex)(Code) | | Specify which item in the Navigation Menu is to be highlighted as selected..
Parameters:
groupIndex - int group index of item to select in menu.
Parameters:
itemIndex - int item index of item to select in menu. |
| setSelectedItem | | public void setSelectedItem(String pageName)(Code) | | This selects the item via pagename if it exists in the menu.
|
| setSizeOption | | public void setSizeOption(int sizeoption)(Code) | | Specifies how the Navigation Menu is to be sized, via percatage or pixels.
Parameters:
sizeoption - int A constant representing the type of size option. |
| setTarget | | public void setTarget(int groupIndex, int itemIndex, String target)(Code) | | Sets the target window for the link of an item in the Navigation Menu.
Parameters:
groupIndex - is the group index of the entry to change the target of.
Parameters:
itemIndex - is the item index of the entry to change the target of.
Parameters:
target - is the new target associated with the link. |
| setTitle | | public void setTitle(int groupIndex, int itemIndex, String title)(Code) | | Sets the title displayed of an item in the Navigation Menu.
Parameters:
groupIndex - is the group index of the entry to change the caption of.
Parameters:
itemIndex - is the item index of the entry to change the caption of.
Parameters:
title - is the new caption for the item. |
| setVisible | | public void setVisible(int groupIndex, int itemIndex, boolean visible)(Code) | | Sets whether the item is visible or not.
Parameters:
groupIndex - is the group index of the entry to hide/show.
Parameters:
itemIndex - is the item index of the entry to hide/show.
Parameters:
visible - is to indicate whether the item should be shown or not. |
| setVisible | | public void setVisible(int groupIndex, boolean visible)(Code) | | Sets whether the group is visible or not.
Parameters:
groupIndex - is the group index of the entry to hide/show.
Parameters:
visible - is to indicate whether the item should be shown or not. |
| setVisible | | public void setVisible(String pageName, boolean visible)(Code) | | This hides/shows the item via pagename if it exists in the menu.
|
| setWidth | | public void setWidth(int width)(Code) | | Sets the width of the Navigation Menu.
Parameters:
width - int The Width of the Navigation Menu |
|
|