|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.pushingpixels.flamingo.api.bcb.BreadcrumbBarCallBack<T>
T
- Type of data associated with each breadcrumb bar item.public abstract class BreadcrumbBarCallBack<T>
The application callback that can be set on JBreadcrumbBar
.
Field Summary | |
---|---|
protected boolean |
throwsExceptions
If true , some of the operations will throw
BreadcrumbBarException . |
Constructor Summary | |
---|---|
BreadcrumbBarCallBack()
|
Method Summary | |
---|---|
java.io.InputStream |
getLeafContent(T leaf)
Returns the input stream with the leaf content. |
java.util.List<StringValuePair<T>> |
getLeafs(java.util.List<BreadcrumbItem<T>> path)
Returns the choice element that corresponds to the specified path. |
java.util.List<StringValuePair<T>> |
getPathChoices(java.util.List<BreadcrumbItem<T>> path)
Returns the choice element that corresponds to the specified path. |
void |
setThrowsExceptions(boolean throwsExceptions)
Sets the indication whether the operations of this breadcrumb bar will throw BreadcrumbBarException . |
void |
setup()
Sets up the callback. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected boolean throwsExceptions
true
, some of the operations will throw
BreadcrumbBarException
.
Constructor Detail |
---|
public BreadcrumbBarCallBack()
Method Detail |
---|
public void setup() throws BreadcrumbBarException
BreadcrumbBarException
- Runtime exception that wraps the cause. Is thrown only when
setThrowsExceptions(boolean)
has been called with
true
parameter.public void setThrowsExceptions(boolean throwsExceptions)
BreadcrumbBarException
.
throwsExceptions
- If true
, the operations of this breadcrumb bar
will throw BreadcrumbBarException
.public java.util.List<StringValuePair<T>> getPathChoices(java.util.List<BreadcrumbItem<T>> path) throws BreadcrumbBarException
null
should be returned. If path is
null
, the "root" elements should be returned
path
- Breadcrumb bar path.
BreadcrumbBarException
- Runtime exception that wraps the cause. Is thrown only when
setThrowsExceptions(boolean)
has been called with
true
parameter.public java.util.List<StringValuePair<T>> getLeafs(java.util.List<BreadcrumbItem<T>> path) throws BreadcrumbBarException
null
should be returned. If path is
null
, the "root" elements should be returned
path
- Breadcrumb bar path.
BreadcrumbBarException
- Runtime exception that wraps the cause. Is thrown only when
setThrowsExceptions(boolean)
has been called with
true
parameter.public java.io.InputStream getLeafContent(T leaf) throws BreadcrumbBarException
null
if this is not applicable.
leaf
- Leaf.
null
if
this is not applicable.
BreadcrumbBarException
- Runtime exception that wraps the cause. Is thrown only when
setThrowsExceptions(boolean)
has been called with
true
parameter.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |