01: //** Copyright Statement ***************************************************
02: //The Salmon Open Framework for Internet Applications (SOFIA)
03: // Copyright (C) 1999 - 2002, Salmon LLC
04: //
05: // This program is free software; you can redistribute it and/or
06: // modify it under the terms of the GNU General Public License version 2
07: // as published by the Free Software Foundation;
08: //
09: // This program is distributed in the hope that it will be useful,
10: // but WITHOUT ANY WARRANTY; without even the implied warranty of
11: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12: // GNU General Public License for more details.
13: //
14: // You should have received a copy of the GNU General Public License
15: // along with this program; if not, write to the Free Software
16: // Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17: //
18: // For more information please visit http://www.salmonllc.com
19: //** End Copyright Statement ***************************************************
20: package com.salmonllc.gui;
21:
22: /**
23: * Represents an Item in a group of a NavigationMenu.
24: * Creation date: (8/23/01 10:06:24 AM)
25: * @author: Fred Cahill
26: */
27: public interface NavigationItemInterface {
28: /**
29: * Returns the number of pixels of horizontal padding for this item in a group.
30: * @return int The number of pixels of horizontal padding.
31: */
32: public int getHorizPadding();
33:
34: /**
35: * Returns the href link of this item.
36: * @return String The href link of the item.
37: */
38: public String getHRef();
39:
40: /**
41: * Returns the submenu name associated with this item.
42: * @return String The submenu name of the item.
43: */
44: public String getSubMenu();
45:
46: /**
47: * Returns the target window name for the href link of this item.
48: * @return String The target window name for the href link of this item.
49: */
50: public String getTarget();
51:
52: /**
53: * Returns the title displayed for this item.
54: * @return String The title of this item.
55: */
56: public String getTitle();
57:
58: /**
59: * Returns whether this item is visible or not.
60: * @return boolean Indicates if item is visible or not.
61: */
62: public boolean getVisible();
63:
64: /**
65: * Sets the number of pixels of horizontal padding for this item
66: * @param iHorizPadding int The number of pixels of horizontal padding.
67: */
68: public void setHorizPadding(int iHorizPadding);
69:
70: /**
71: * Sets the href link for this item
72: * @param href String The href link of the item.
73: */
74: public void setHRef(String sHRef);
75:
76: /**
77: * Sets the submenu name for this item
78: * @param sSubMenu String The submenu name of the item.
79: */
80: public void setSubMenu(String sSubMenu);
81:
82: /**
83: * Sets the target window name for the href link of this item
84: * @param sTarget String The target window name of the href link of this item.
85: */
86: public void setTarget(String sTarget);
87:
88: /**
89: * Sets the title displayed for this item
90: * @param sTitle String The title of the item.
91: */
92: public void setTitle(String sTitle);
93:
94: /**
95: * Sets whether this item is visible or not
96: * @param bVisible boolean Indicates if item is visible or not.
97: */
98: public void setVisible(boolean bVisible);
99: }
|