|
LEONARDI Application Composer - 8.9.0.40 by W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectleon.view.web.LyWebDecoration
public class LyWebDecoration
This class defines static parts of the web decoration switch the choosen skin. It must be inherited in order to generate HTML pages.
Field Summary | |
---|---|
static java.lang.String |
__VERSION
|
static int |
AREA_BORDER_BEGIN
Decoration code relative to area border begining. |
static int |
AREA_BORDER_BEGIN_NOT_FULL_HEIGHT
Decoration code relative to area border begining without a full height. |
static int |
AREA_BORDER_BEGIN_NOT_FULL_WIDTH
Decoration code relative to area border begining without a full width. |
static int |
AREA_BORDER_BEGIN_NOT_FULL_WIDTH_AND_HEIGHT
Decoration code relative to area border begining without a full width and height. |
static int |
AREA_BORDER_END
Decoration code relative to area border end. |
static int |
AREA_BORDER_LEFT
Decoration code relative to area border left side. |
static int |
AREA_BORDER_LEFT_NOT_FULL_HEIGHT
Decoration code relative to area border left side without a full height. |
static int |
AREA_BORDER_LEFT_NOT_FULL_WIDTH
Decoration code relative to area border left side without a full width. |
static int |
AREA_BORDER_LEFT_NOT_FULL_WIDTH_AND_HEIGHT
Decoration code relative to area border left side without a full width and height. |
static int |
AREA_BORDER_RIGHT
Decoration code relative to area border right side. |
static int |
CLOSE_ZONE
Decoration code relative close zone. |
static int |
CONTENT_BEGIN
Decoration code relative to the content begining. |
static int |
CONTENT_BEGIN_FULL_HEIGHT
Decoration code relative to the content begining with full height. |
static int |
CONTENT_END
Decoration code relative to the content end. |
static int |
CONTENT_FOOTER
Decoration code relative to the content footer. |
static int |
CONTENT_LEFT
Decoration code relative to the left of the content. |
static int |
CONTENT_RIGHT
Decoration code relative to the right of the content. |
static int |
CONTENT_TOP
Decoration code relative to the top of the content. |
static int |
FORM_FIELDS_BEGIN
Decoration code relative to the form field begining. |
static int |
FORM_FIELDS_END
Decoration code relative to the form field end. |
static int |
HEADER_BAR_BEGIN
Decoration code relative to the header bar begining. |
static int |
HEADER_BAR_END
Decoration code relative to the header bar end. |
static int |
HORIZONTAL_TOOLBAR_BEGIN
Decoration code relative to horizontal toolbar begining. |
static int |
INNER_WINDOW_BEGIN
Decoration code relative inner window begining. |
static int |
OPEN_ZONE_1
Decoration code relative open zone. |
static int |
TOOLBAR_LABEL
Decoration code relative to the toolbar label. |
static int |
TOOLBAR_LABEL_END
Decoration code relative to the toolbar end of the label. |
static int |
VERTICAL_TOOLBAR_BEGIN
Decoration code relative to vertical toolbar begining. |
static int |
VERTICAL_TOOLBAR_END
Decoration code relative to vertical toolbar end. |
static int |
VERTICAL_TOOLBAR_LEFT
Decoration code relative to vertical toolbar left side. |
static int |
VERTICAL_TOOLBAR_RIGHT
Decoration code relative to vertical toolbar right side. |
static int |
WINDOW_BEGIN
Decoration code relative to the window begining. |
static int |
WINDOW_BEGIN_NOT_FULL_HEIGHT
Decoration code relative to the window begining without a full height. |
static int |
WINDOW_BOTTOM
Decoration code relative to the window bottom. |
static int |
WINDOW_END
Decoration code relative to the window end. |
static int |
WINDOW_HEADER_LEFT
Decoration code relative to the left window's header side. |
static int |
WINDOW_HEADER_RIGHT
Decoration code relative to the right window's header side. |
static int |
WINDOW_LEFT
Decoration code relative to the window left side. |
static int |
WINDOW_RIGHT
Decoration code relative to the window right side. |
static int |
WINDOW_TOP
Decoration code relative to the window top. |
Constructor Summary | |
---|---|
LyWebDecoration(LyEnvironment environment)
Default protected constructor. |
Method Summary | |
---|---|
java.lang.String |
getBodyClassString(LyWebPageWriter writer)
Returns the CSS class string to be used for body tag of a page writer. |
java.lang.String |
getClassName(LyComponent component,
int type,
LyWebPageWriter pw)
Returns the CSS class name to be used for given component and page writer. |
java.lang.String |
getClassName(LyComponent component,
LyWebPageWriter pw)
Returns the CSS class name to be used for given component and page writer. |
static int |
getClosingDecoration(int whatToShow)
Method used to get code of the related closing decoration. |
static int |
getOpeningDecoration(int whatToShow)
Method used to get code of the related opening decoration. |
java.lang.String |
getPageDecoration(int whatToShow)
Method used to produce the decoration (skin) as a String. |
java.lang.String |
getPageDecoration(int whatToShow,
java.lang.Object param)
Method used to produce the decoration (skin) as a String. |
java.lang.String |
getSkinFile()
Gets the current skin. |
java.lang.String |
getSkinPath()
Gets the path of current skin. |
java.lang.String |
getSpecificCSSFile()
Gets the url of the specific CSS file. |
boolean |
isUsingDefaultBackground()
Indicates if we may use the default background from ressources (or if it is managed by the skin). |
boolean |
needPageDecoration(LyWebPageWriter pw,
int whatToShow)
Method used to check if we may apply this decoration or not (avoid duplicate border). |
void |
setEnvironment(LyEnvironment environment)
Sets the current environment. |
void |
setSkinFile(java.lang.String skinFile,
LyEnvironment environment)
Sets the skin and initialize the environment. |
void |
writePageDecoration(LyWebPageWriter pw,
int whatToShow)
Method used to set the decoration (skin) into the specified writer. |
void |
writePageDecoration(LyWebPageWriter pw,
int whatToShow,
java.lang.Object param)
Method used to set the decoration (skin) into the specified writer. |
void |
writePageDecoration(java.io.Writer pw,
int whatToShow)
Method used to set the decoration (skin) into the specified writer. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String __VERSION
public static final int WINDOW_BEGIN
public static final int WINDOW_END
public static final int WINDOW_LEFT
public static final int WINDOW_RIGHT
public static final int WINDOW_TOP
public static final int WINDOW_BOTTOM
public static final int WINDOW_HEADER_LEFT
public static final int WINDOW_HEADER_RIGHT
public static final int HEADER_BAR_BEGIN
public static final int HEADER_BAR_END
public static final int CONTENT_BEGIN
public static final int CONTENT_BEGIN_FULL_HEIGHT
public static final int CONTENT_TOP
public static final int CONTENT_LEFT
public static final int CONTENT_RIGHT
public static final int CONTENT_FOOTER
public static final int CONTENT_END
public static final int FORM_FIELDS_BEGIN
public static final int FORM_FIELDS_END
public static final int TOOLBAR_LABEL
public static final int TOOLBAR_LABEL_END
public static final int WINDOW_BEGIN_NOT_FULL_HEIGHT
public static final int OPEN_ZONE_1
public static final int CLOSE_ZONE
public static final int INNER_WINDOW_BEGIN
public static final int AREA_BORDER_BEGIN
public static final int AREA_BORDER_BEGIN_NOT_FULL_WIDTH
public static final int AREA_BORDER_BEGIN_NOT_FULL_HEIGHT
public static final int AREA_BORDER_BEGIN_NOT_FULL_WIDTH_AND_HEIGHT
public static final int AREA_BORDER_LEFT
public static final int AREA_BORDER_LEFT_NOT_FULL_WIDTH
public static final int AREA_BORDER_LEFT_NOT_FULL_HEIGHT
public static final int AREA_BORDER_LEFT_NOT_FULL_WIDTH_AND_HEIGHT
public static final int AREA_BORDER_RIGHT
public static final int AREA_BORDER_END
public static final int VERTICAL_TOOLBAR_BEGIN
public static final int VERTICAL_TOOLBAR_LEFT
public static final int VERTICAL_TOOLBAR_RIGHT
public static final int VERTICAL_TOOLBAR_END
public static final int HORIZONTAL_TOOLBAR_BEGIN
Constructor Detail |
---|
public LyWebDecoration(LyEnvironment environment)
environment
- the application environmentMethod Detail |
---|
public static int getClosingDecoration(int whatToShow)
whatToShow
- the code of the opening decoration
public static int getOpeningDecoration(int whatToShow)
whatToShow
- the code of the closing decoration
public void setEnvironment(LyEnvironment environment)
environment
- the environmentpublic void setSkinFile(java.lang.String skinFile, LyEnvironment environment)
skinFile
- the skinenvironment
- the environmentgetSkinFile()
public void writePageDecoration(LyWebPageWriter pw, int whatToShow)
pw
- writer to write piece of decoration towhatToShow
- what part of the decoration shall be written (see static values)public void writePageDecoration(LyWebPageWriter pw, int whatToShow, java.lang.Object param)
pw
- writer to write piece of decoration towhatToShow
- what part of the decoration shall be written (see static values)param
- parameter of the decoration to be producedpublic void writePageDecoration(java.io.Writer pw, int whatToShow) throws java.io.IOException
pw
- writer to write piece of decoration towhatToShow
- what part of the decoration shall be written (see static values)
java.io.IOException
public boolean needPageDecoration(LyWebPageWriter pw, int whatToShow)
pw
- writer to write piece of decoration towhatToShow
- what part of the decoration shall be written (see static values)
public java.lang.String getPageDecoration(int whatToShow)
whatToShow
- decoration code of the part that shall be written (see static values)
public java.lang.String getPageDecoration(int whatToShow, java.lang.Object param)
whatToShow
- decoration code of the part that shall be written (see static values)param
- parameter of the decoration to be produced
public boolean isUsingDefaultBackground()
public java.lang.String getSkinFile()
#setSkin(String, LyEnvironment)
public java.lang.String getSkinPath()
public java.lang.String getSpecificCSSFile()
public java.lang.String getBodyClassString(LyWebPageWriter writer)
writer
- the page writer generating the body tag.
public java.lang.String getClassName(LyComponent component, LyWebPageWriter pw)
component
- the component used to generate HTML code.pw
- current page writer.
public java.lang.String getClassName(LyComponent component, int type, LyWebPageWriter pw)
component
- the component used to generate HTML code.type
- the type of the class to be generated. Depends on the class of the
component.pw
- current page writer.
|
(c) January 2013 - W4 S.A. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |