|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.pepper.platform.program.Section
public class Section
This class represents a Section object for a given program. The Section object contains a list of Pages.
Constructor Summary | |
---|---|
Section(Section parentSection,
com.pepper.platform.program.PageMgr pageMgr)
Creates a new Section instance. |
Method Summary | |
---|---|
void |
addPage(Page page)
Add a page to the section. |
boolean |
arePagesLoaded()
Returns true if pages have been loaded. |
boolean |
deleteOnClose()
return true if the section should be deleted when closing the package |
String |
getDescription()
Returns the section description. |
String |
getIconName()
Returns the section icon name. |
String |
getId()
Returns the Id for the Section. |
boolean |
getIsContentSection()
Describe getContentSection method here. |
String |
getName()
Returns the display name for the section. |
Page |
getPage(int index)
Returns the page specified by the given index. |
PageList |
getPages()
Returns the PageList of this section. |
Section |
getParentSection()
Returns the parent of this section if it exists, or null . |
SectionPage |
getSectionPage()
Return the SectionPage (if any) for the current Section. |
boolean |
getShowDeleteButton()
get state of whether or not to show the delete button on the tab representing this section |
boolean |
getSync()
Returns true if the section should be synced when a sync occurs |
int |
getTabIndex()
Returns the section tab index. |
String |
getViewId()
Get the browser view id associated with this section |
int |
insertPage(int index,
Page page)
Insert the page in the list and return position actually inserted |
boolean |
isVisible()
Returns true if the section has a UI. |
boolean |
isWebSection()
Returns false because it's not a WebSection |
boolean |
saveTombstones()
return true if tombstones are enabled for this section |
void |
setDeleteOnClose(boolean state)
set to true to have section be deleted when package is closed |
void |
setDescription(String desc)
Sets the section description. |
void |
setIconName(String iconName)
Sets the section icon name. |
void |
setId(String id)
Sets the unique ID for the Section. |
void |
setIsContentSection(boolean state)
Describe setContentSection method here. |
void |
setName(String name)
Sets the display name for the section. |
void |
setPageMgr(com.pepper.platform.program.PageMgr pageMgr)
Set the process id that this section belongs to |
void |
setPagesLoaded(boolean pagesLoaded)
Sets the the section attribute indicating whether or not pages have been loaded. |
void |
setSaveTombstones(boolean state)
set to true to have tombstones saved when moving/deleting the section |
void |
setShowDeleteButton(boolean state)
set whether or not to show the delete button on the tab representing this section |
void |
setSync(boolean state)
Sets whether the section should be synced when a sync occurs |
void |
setTabIndex(int index)
Sets the section tab index. |
void |
setViewId(String viewId)
Set the browser view id associated with |
void |
setVisible(boolean visible)
Set to true if the section has a UI, otherwise false. |
String |
toString()
Debug method to dump contents of Section
to a String . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public Section(Section parentSection, com.pepper.platform.program.PageMgr pageMgr)
Section
instance.
parentSection
- Parent of this section. May be null.pageMgr
- PageMgr for the program. Must not be null.Method Detail |
---|
public boolean arePagesLoaded()
boolean
indicating whether or
not pages have been loaded.public void setPagesLoaded(boolean pagesLoaded)
pagesLoaded
- a boolean
value.public boolean isVisible()
boolean
indicating whether or
not the section has a UI.public void setVisible(boolean visible)
visible
- a boolean
value.public void setPageMgr(com.pepper.platform.program.PageMgr pageMgr)
pageMgr
- an Integer
valuepublic void setIsContentSection(boolean state)
setContentSection
method here.
state
- a boolean
valuepublic boolean getIsContentSection()
getContentSection
method here.
boolean
valuepublic Section getParentSection()
null
.
Section
instance, or null
.public PageList getPages()
PageList
of this section. Note -
Any operations on the PageList
should be externally
synchronized on using the instance lock. See PageList
for more information.
PageList
instance.public Page getPage(int index)
index
- an int
value specifying the page index.
Page
instance if it exists,
else null
.public void addPage(Page page)
page
- the Page
instance to be added.public int insertPage(int index, Page page)
index
- an int
valuepage
- a Page
value
int
valuepublic SectionPage getSectionPage()
SectionPage
value.public String getId()
String
value containing the section Id.public void setId(String id)
id
- a String
value specifying the section Id.public String getViewId()
String
valuepublic void setViewId(String viewId)
viewId
- a String
valuepublic String getName()
String
value containing the display name.public boolean isWebSection()
boolean
valuepublic boolean deleteOnClose()
public void setDeleteOnClose(boolean state)
public void setSaveTombstones(boolean state)
public boolean saveTombstones()
public void setShowDeleteButton(boolean state)
public boolean getShowDeleteButton()
public boolean getSync()
public void setSync(boolean state)
public void setName(String name)
name
- a String
value containing the display name.public int getTabIndex()
public void setTabIndex(int index)
index
- the section tab index.public void setDescription(String desc)
desc
- a String
value containing the description.public String getDescription()
String
value containing the description.public void setIconName(String iconName)
iconName
- a String
value specifing the icon name.public String getIconName()
String
value containing the icon name.public String toString()
Section
to a String
.
toString
in class Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |